@somewhatabstract/x 0.1.0 → 0.2.0

package/CODE_OF_CONDUCT.md

@@ -1,76 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at jeff[at]somewhatabstract[dot]com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq

package/CONTRIBUTING.md

@@ -1,70 +0,0 @@
-# Contributing to `x`
-
-🙇Thank you for your interest in contributing to this 📦.
-
-Whether raising an issue, reviewing a pull request, or implementing a change, the participation of others is a wonderful 🎁. Read on to find out how you can get involved.
-
-📖 Be sure to read our [Code of Conduct](CODE_OF_CONDUCT.md).
-
-## 🛑 Bugs And Feature Requests
-
-If you find a bug or want to make enhancements to the project, head on over to the [🔗Issues](https://github.com/somewhatabstract/x/issues) section and raise an issue. The issue templates will guide you in providing details that will help others help you.
-
-## 💻 Code Changes
-
-### ⓵ Making your first change
-
-Look for bugs or feature requests with the [good first issue](https://github.com/somewhatabstract/x/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) or [help wanted](https://github.com/somewhatabstract/x/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22+) labels and have a go at implementing a change. Once your change is ready, you can submit a pull request.
-
-### 🎬 Getting Started
-
-To work in the `x` repository, follow these steps:
-
-1. Clone the repository
-   - `gh repo clone somewhatabstract/x`
-   - -or-
-   - `git clone git@github.com:somewhatabstract/x.git`
-2. Install `pnpm`
-   - `corepack enable pnpm`
-   - `corepack prepare pnpm --activate`
-3. Run `pnpm install` (or `pnpm i`) to install the dependencies
-
-You can now work on `x`. We prefer [🔗Visual Studio Code](https://code.visualstudio.com/) as our development environment (it's cross-platform and awesome), but please use what you feel comfortable with (we'll even forgive you for using vim).
-
-### 🧪 Code Quality
-
-#### Manual
-
-We love code reviews. If there are open pull requests, please feel free to review them and provide feedback. Feedback is a gift and code reviews are often a bottleneck in getting new things released. Jump in, even if you don't know anything; you probably know more than you think.
-
-💭**REMEMBER** Be kind and considerate. Folks are volunteering their time and code reviews are a moment of vulnerability where a criticism of the code can easily become a criticism of the individual that wrote it.
-
-1. Take your time
-2. Consider how you might receive the feedback you are giving if it were attached to code you wrote
-3. Favor asking questions over prescribing solutions.
-
-#### Automated
-
-To ensure code quality, we use TypeScript, biome, and vitest. These are all executed when you submit a pull request to ensure contributions meet our code quality standards.
-
-To execute these operations outside of a pull request, you can use `pnpm`.
-
-- `pnpm typecheck`
-- `pnpm lint`
-- `pnpm test`
-
-If you make changes that change snapshots, you may need to run tests with the `-u` vitest option and commit the updated snapshot files along with the rest of your contribution.
-
-💭**REMEMBER** If you would like to contribute code changes to the project, first make sure there's a corresponding issue for the change you wish to make.
-
-## 📦 Build And Publish
-
-Anyone can create a local build of the distributed code by running `pnpm build`.
-
-Running the build will execute tests first.
-
-### Publishing
-
-Publishing is automated through our use of [changesets][1]. When a PR is merged to `main`, a release PR is created that bundles all the changes since the last release. When we are ready to release, this bundled PR is merged to `main` which triggers changesets to publish to npm via trusted publishing.
-
-[1]:https://github.com/changesets/changesets/blob/main/README.md#documentation

package/biome.json

@@ -1,39 +0,0 @@
-{
-    "$schema": "https://biomejs.dev/schemas/2.4.3/schema.json",
-    "formatter": {
-        "enabled": true,
-        "indentStyle": "space",
-        "indentWidth": 4,
-        "bracketSpacing": false,
-        "includes": ["**", "!dist/**", "!coverage/**"]
-    },
-    "linter": {
-        "enabled": true,
-        "includes": ["**", "!dist/**", "!coverage/**"]
-    },
-    "assist": {
-        "enabled": true,
-        "includes": ["**", "!dist/**", "!coverage/**"]
-    },
-    "overrides": [
-        {
-            "includes": ["**/*.test.*"],
-            "linter": {
-                "rules": {
-                    "suspicious": {
-                        "noExplicitAny": "off"
-                    }
-                }
-            }
-        },
-        {
-            "includes": ["*.json", "*.jsonc"],
-            "json": {
-                "parser": {
-                    "allowComments": true,
-                    "allowTrailingCommas": true
-                }
-            }
-        }
-    ]
-}

package/src/__tests__/build-environment.test.ts

@@ -1,285 +0,0 @@
-import * as fs from "node:fs/promises";
-import * as path from "node:path";
-import {beforeEach, describe, expect, it, vi} from "vitest";
-import {buildEnvironment} from "../build-environment";
-
-// Mock the fs module
-vi.mock("node:fs/promises", () => ({
-    readFile: vi.fn(),
-}));
-
-describe("buildEnvironment", () => {
-    beforeEach(() => {
-        vi.clearAllMocks();
-    });
-
-    it("should preserve existing environment variables", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {
-            EXISTING_VAR: "existing-value",
-            PATH: "/usr/bin:/bin",
-        };
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "test-workspace",
-                version: "1.0.0",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.EXISTING_VAR).toBe("existing-value");
-    });
-
-    it("should prepend workspace node_modules/.bin to PATH", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {
-            PATH: "/usr/bin:/bin",
-        };
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "test-workspace",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        const expectedPath = path.join(workspaceRoot, "node_modules", ".bin");
-        expect(env.PATH).toContain(expectedPath);
-    });
-
-    it("should set npm_command to exec", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify({}));
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_command).toBe("exec");
-    });
-
-    it("should set INIT_CWD to current working directory", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-        const expectedCwd = process.cwd();
-
-        vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify({}));
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.INIT_CWD).toBe(expectedCwd);
-    });
-
-    it("should set npm_package_name from workspace package.json", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                version: "2.5.0",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_name).toBe("my-workspace");
-    });
-
-    it("should set npm_package_version from workspace package.json", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                version: "2.5.0",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_version).toBe("2.5.0");
-    });
-
-    it("should set npm_execpath to node executable path", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify({}));
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_execpath).toBe(process.execPath);
-    });
-
-    it("should include package name in npm_config_user_agent", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify({}));
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_config_user_agent).toContain("x/");
-    });
-
-    it("should include node version in npm_config_user_agent", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(JSON.stringify({}));
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_config_user_agent).toContain("node/");
-    });
-
-    it("should set npm_command to exec when package.json is missing", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockRejectedValue(
-            new Error("ENOENT: no such file"),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_command).toBe("exec");
-    });
-
-    it("should set INIT_CWD when package.json is missing", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockRejectedValue(
-            new Error("ENOENT: no such file"),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.INIT_CWD).toBe(process.cwd());
-    });
-
-    it("should include npm_package_description if present", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                description: "A test workspace",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_description).toBe("A test workspace");
-    });
-
-    it("should convert object fields to JSON strings", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                repository: {
-                    type: "git",
-                    url: "https://github.com/test/repo",
-                },
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_repository).toBe(
-            JSON.stringify({
-                type: "git",
-                url: "https://github.com/test/repo",
-            }),
-        );
-    });
-
-    it("should set npm_package_license from workspace package.json", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                license: "MIT",
-                author: "John Doe",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_license).toBe("MIT");
-    });
-
-    it("should set npm_package_author from workspace package.json", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const currentEnv = {PATH: "/usr/bin"};
-
-        vi.mocked(fs.readFile).mockResolvedValue(
-            JSON.stringify({
-                name: "my-workspace",
-                license: "MIT",
-                author: "John Doe",
-            }),
-        );
-
-        // Act
-        const env = await buildEnvironment(workspaceRoot, currentEnv);
-
-        // Assert
-        expect(env.npm_package_author).toBe("John Doe");
-    });
-});

package/src/__tests__/discover-packages.test.ts

@@ -1,196 +0,0 @@
-import * as manypkg from "@manypkg/get-packages";
-import {beforeEach, describe, expect, it, vi} from "vitest";
-import {discoverPackages} from "../discover-packages";
-import {HandledError} from "../errors";
-
-// Mock @manypkg/get-packages
-vi.mock("@manypkg/get-packages", () => ({
-    getPackages: vi.fn(),
-}));
-
-describe("discoverPackages", () => {
-    beforeEach(() => {
-        vi.clearAllMocks();
-    });
-
-    it("should return packages from @manypkg", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [
-                {
-                    packageJson: {name: "pkg1", version: "1.0.0"},
-                    dir: "/test/workspace/pkg1",
-                },
-                {
-                    packageJson: {name: "pkg2", version: "2.0.0"},
-                    dir: "/test/workspace/pkg2",
-                },
-            ],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        const result = await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(result).toHaveLength(2);
-    });
-
-    it("should map package names correctly", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [
-                {
-                    packageJson: {name: "test-package", version: "1.0.0"},
-                    dir: "/test/workspace/pkg",
-                },
-            ],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        const result = await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(result[0].name).toBe("test-package");
-    });
-
-    it("should map package paths correctly", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [
-                {
-                    packageJson: {name: "test-package", version: "1.0.0"},
-                    dir: "/test/workspace/packages/test",
-                },
-            ],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        const result = await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(result[0].path).toBe("/test/workspace/packages/test");
-    });
-
-    it("should map package versions correctly", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [
-                {
-                    packageJson: {name: "test-package", version: "3.2.1"},
-                    dir: "/test/workspace/pkg",
-                },
-            ],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        const result = await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(result[0].version).toBe("3.2.1");
-    });
-
-    it("should use 'unknown' for missing version", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [
-                {
-                    packageJson: {name: "test-package"},
-                    dir: "/test/workspace/pkg",
-                },
-            ],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        const result = await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(result[0].version).toBe("unknown");
-    });
-
-    it("should call getPackages with workspace root", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const mockPackages = {
-            packages: [],
-        };
-
-        vi.mocked(manypkg.getPackages).mockResolvedValue(mockPackages as any);
-
-        // Act
-        await discoverPackages(workspaceRoot);
-
-        // Assert
-        expect(manypkg.getPackages).toHaveBeenCalledWith(workspaceRoot);
-    });
-
-    it("should rethrow HandledError type as is", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const handledError = new HandledError("Test handled error");
-
-        vi.mocked(manypkg.getPackages).mockRejectedValue(handledError);
-
-        // Act
-        const underTest = () => discoverPackages(workspaceRoot);
-
-        // Assert
-        await expect(underTest).rejects.toThrow(HandledError);
-    });
-
-    it("should rethrow HandledError message as is", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const handledError = new HandledError("Test handled error");
-
-        vi.mocked(manypkg.getPackages).mockRejectedValue(handledError);
-
-        // Act
-        const underTest = () => discoverPackages(workspaceRoot);
-
-        // Assert
-        await expect(underTest).rejects.toThrow("Test handled error");
-    });
-
-    it("should wrap non-HandledError in HandledError type", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const error = new Error("Original error");
-
-        vi.mocked(manypkg.getPackages).mockRejectedValue(error);
-
-        // Act
-        const underTest = () => discoverPackages(workspaceRoot);
-
-        // Assert
-        await expect(underTest).rejects.toThrow(HandledError);
-    });
-
-    it("should use expected message when wrapping non-HandledError", async () => {
-        // Arrange
-        const workspaceRoot = "/test/workspace";
-        const error = new Error("Original error");
-
-        vi.mocked(manypkg.getPackages).mockRejectedValue(error);
-
-        // Act
-        const underTest = () => discoverPackages(workspaceRoot);
-
-        // Assert
-        await expect(underTest).rejects.toThrow("Failed to discover packages");
-    });
-});