refactor: rename package from @scottluskcis/outport to @scottluskcis/export-toolkit v1.0.0 (#31)

* Initial plan

* refactor: rename package from @scottluskcis/outport to @scottluskcis/export-toolkit v1.0.0

Co-authored-by: scottluskcis <[email protected]>

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: scottluskcis <[email protected]>

Author: Copilot

.github/workflows/publish.yml

@@ -39,4 +39,4 @@ jobs:
 
       - name: Report publication
         run: |
-          echo "✅ Successfully published @scottluskcis/outport@$(node -p "require('./package.json').version") to npm"
+          echo "✅ Successfully published @scottluskcis/export-toolkit@$(node -p "require('./package.json').version") to npm"

CHANGELOG.md

@@ -5,6 +5,46 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 🚀 Migration Note
+
+**The package has been renamed from `@scottluskcis/outport` to `@scottluskcis/export-toolkit`.**
+
+To migrate:
+
+```bash
+# Uninstall the old package
+npm uninstall @scottluskcis/outport
+
+# Install the new package
+npm install @scottluskcis/export-toolkit
+```
+
+Update your imports:
+
+```typescript
+// Before
+import { outport } from '@scottluskcis/outport';
+
+// After
+import { outport } from '@scottluskcis/export-toolkit';
+```
+
+The API remains unchanged - only the package name has changed.
+
+---
+
+## [1.0.0] - 2025-10-23
+
+### Changed
+
+- **BREAKING**: Package renamed from `@scottluskcis/outport` to `@scottluskcis/export-toolkit`
+- **BREAKING**: Repository renamed from `scottluskcis/outport` to `scottluskcis/export-toolkit`
+- Version bumped to 1.0.0 to signify package stability and the rename
+
+### Note
+
+This is purely a rename - the API and functionality remain unchanged. Upgrading requires only updating the package name in your `package.json` and import statements.
+
 ## [Unreleased]
 
 ## [0.0.7] - 2025-10-21
@@ -15,7 +55,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- **Initial public release** of `@scottluskcis/outport`
+- **Initial public release** of `@scottluskcis/export-toolkit` (formerly `@scottluskcis/outport`)
 - **Fluent Builder API** - Intuitive, chainable configuration for data exports
 - **CSV Export Support**
   - Configurable delimiters (comma, tab, semicolon, pipe)
@@ -76,5 +116,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added npm provenance for supply chain security
 - Implemented granular npm access tokens
 
-[unreleased]: https://github.com/scottluskcis/outport/compare/v0.0.7...HEAD
-[0.0.7]: https://github.com/scottluskcis/outport/releases/tag/v0.0.7
+[unreleased]: https://github.com/scottluskcis/export-toolkit/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/scottluskcis/export-toolkit/releases/tag/v1.0.0
+[0.0.7]: https://github.com/scottluskcis/export-toolkit/releases/tag/v0.0.7

README.md

@@ -1,13 +1,13 @@
-# outport
+# export-toolkit
 
 > Tool for exporting data to a format that can be used for reporting such as CSV, JSON, etc.
 
-[![CI](https://github.com/scottluskcis/outport/actions/workflows/ci.yml/badge.svg)](https://github.com/scottluskcis/outport/actions/workflows/ci.yml)
+[![CI](https://github.com/scottluskcis/export-toolkit/actions/workflows/ci.yml/badge.svg)](https://github.com/scottluskcis/export-toolkit/actions/workflows/ci.yml)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![Node Version](https://img.shields.io/badge/node-%3E%3D18.0.0-brightgreen.svg)](https://nodejs.org)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue.svg)](https://www.typescriptlang.org/)
-[![npm version](https://badge.fury.io/js/@scottluskcis%2Foutport.svg)](https://www.npmjs.com/package/@scottluskcis/outport)
-[![npm downloads](https://img.shields.io/npm/dm/@scottluskcis/outport.svg)](https://www.npmjs.com/package/@scottluskcis/outport)
+[![npm version](https://badge.fury.io/js/@scottluskcis%2Fexport-toolkit.svg)](https://www.npmjs.com/package/@scottluskcis/export-toolkit)
+[![npm downloads](https://img.shields.io/npm/dm/@scottluskcis/export-toolkit.svg)](https://www.npmjs.com/package/@scottluskcis/export-toolkit)
 
 ## ✨ Features
 
@@ -25,17 +25,17 @@
 ### Installation
 
 ```bash
-npm install @scottluskcis/outport
+npm install @scottluskcis/export-toolkit
 # or
-pnpm add @scottluskcis/outport
+pnpm add @scottluskcis/export-toolkit
 # or
-yarn add @scottluskcis/outport
+yarn add @scottluskcis/export-toolkit
 ```
 
 ### Simple Export
 
 ```typescript
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 
 interface User {
   id: number;
@@ -104,7 +104,7 @@ console.log(`Total exported: ${result.value}`);
 
 ```typescript
 import { Command } from 'commander';
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 
 const program = new Command();
 
@@ -224,8 +224,8 @@ Node.js File System
 
 ```bash
 # Clone the repository
-git clone https://github.com/scottluskcis/outport.git
-cd outport
+git clone https://github.com/scottluskcis/export-toolkit.git
+cd export-toolkit
 
 # Install dependencies
 pnpm install
@@ -249,7 +249,7 @@ pnpm install
 ### Project Structure
 
 ```
-outport/
+export-toolkit/
 ├── .github/           # GitHub Actions workflows and configs
 ├── docs/              # Documentation
 │   └── csv-writer.md  # CSV Writer usage guide
@@ -327,6 +327,6 @@ MIT © [scottluskcis](https://github.com/scottluskcis)
 
 ## 🔗 Links
 
-- [GitHub Repository](https://github.com/scottluskcis/outport)
-- [Issue Tracker](https://github.com/scottluskcis/outport/issues)
-- [Changelog](https://github.com/scottluskcis/outport/blob/main/CHANGELOG.md)
+- [GitHub Repository](https://github.com/scottluskcis/export-toolkit)
+- [Issue Tracker](https://github.com/scottluskcis/export-toolkit/issues)
+- [Changelog](https://github.com/scottluskcis/export-toolkit/blob/main/CHANGELOG.md)

docs/builder-api.md

@@ -5,7 +5,7 @@ The Builder API provides a fluent, chainable interface for configuring and execu
 ## Quick Start
 
 ```typescript
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 
 // Simple CSV export
 await outport<User>().to('./users.csv').write(users);
@@ -307,7 +307,7 @@ Perfect for CLI tools using Commander.js:
 
 ```typescript
 import { Command } from 'commander';
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 
 const program = new Command();
 
@@ -343,7 +343,7 @@ program.parse();
 ### Example 1: Database Export with Pagination
 
 ```typescript
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 import { db } from './database';
 
 async function* fetchAllUsers() {
@@ -532,7 +532,7 @@ await outport<User>()
 ### Before (Direct Writer)
 
 ```typescript
-import { CsvWriter } from '@scottluskcis/outport';
+import { CsvWriter } from '@scottluskcis/export-toolkit';
 
 const writer = new CsvWriter<User>({
   type: 'csv',
@@ -550,7 +550,7 @@ const result = await writer.write(users);
 ### After (Builder API)
 
 ```typescript
-import { outport } from '@scottluskcis/outport';
+import { outport } from '@scottluskcis/export-toolkit';
 
 const result = await outport<User>()
   .to('./users.csv')

docs/csv-writer.md

@@ -7,7 +7,7 @@ Quick reference for using the `CsvWriter` class to export data to CSV files.
 ### Simple Write
 
 ```typescript
-import { CsvWriter } from '@scottluskcis/outport';
+import { CsvWriter } from '@scottluskcis/export-toolkit';
 
 interface User {
   id: number;
@@ -177,7 +177,7 @@ if (result.success) {
 Use the `WriterFactory` to create writers:
 
 ```typescript
-import { WriterFactory } from '@scottluskcis/outport';
+import { WriterFactory } from '@scottluskcis/export-toolkit';
 
 const writer = WriterFactory.create<User>({
   type: 'csv',

docs/json-writer.md

@@ -7,7 +7,7 @@ Quick reference for using the `JsonWriter` class to export data to JSON files.
 ### Simple Write
 
 ```typescript
-import { JsonWriter } from '@scottluskcis/outport';
+import { JsonWriter } from '@scottluskcis/export-toolkit';
 
 interface User {
   id: number;
@@ -158,7 +158,7 @@ if (result.success) {
 Use the `WriterFactory` to create writers:
 
 ```typescript
-import { WriterFactory } from '@scottluskcis/outport';
+import { WriterFactory } from '@scottluskcis/export-toolkit';
 
 const writer = WriterFactory.create<User>({
   type: 'json',

docs/release-process.md

@@ -1,6 +1,6 @@
 # Release Process
 
-This document outlines the standardized release process for `@scottluskcis/outport`.
+This document outlines the standardized release process for `@scottluskcis/export-toolkit`.
 
 ## Pre-Release Checklist
 
@@ -49,8 +49,8 @@ Follow the [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) format:
    - **Security** - Security improvements
 4. **Update comparison links at bottom of file**:
    ```markdown
-   [unreleased]: https://github.com/scottluskcis/outport/compare/vX.Y.Z...HEAD
-   [x.y.z]: https://github.com/scottluskcis/outport/compare/vX.Y.Z-1...vX.Y.Z
+   [unreleased]: https://github.com/scottluskcis/export-toolkit/compare/vX.Y.Z...HEAD
+   [x.y.z]: https://github.com/scottluskcis/export-toolkit/compare/vX.Y.Z-1...vX.Y.Z
    ```
 
 Example:
@@ -69,8 +69,8 @@ Example:
 
 - Bug fix for issue #123
 
-[unreleased]: https://github.com/scottluskcis/outport/compare/v0.0.7...HEAD
-[0.0.7]: https://github.com/scottluskcis/outport/compare/v0.0.6...v0.0.7
+[unreleased]: https://github.com/scottluskcis/export-toolkit/compare/v0.0.7...HEAD
+[0.0.7]: https://github.com/scottluskcis/export-toolkit/compare/v0.0.6...v0.0.7
 ```
 
 ### 4. Commit Changelog
@@ -118,7 +118,7 @@ This pushes:
 ### 3. Create GitHub Release
 
 1. **Navigate to Releases**:
-   - Go to: https://github.com/scottluskcis/outport/releases/new
+   - Go to: https://github.com/scottluskcis/export-toolkit/releases/new
 
 2. **Select the Tag**:
    - Choose the tag you just created (e.g., `v0.0.7`)
@@ -137,7 +137,7 @@ This pushes:
 ### 4. Monitor Workflow
 
 1. **Watch the GitHub Action**:
-   - Go to: https://github.com/scottluskcis/outport/actions
+   - Go to: https://github.com/scottluskcis/export-toolkit/actions
    - Look for "Publish to npm" workflow
    - Ensure it completes successfully
 
@@ -152,29 +152,29 @@ After the workflow completes:
 1. **Check npm Registry**:
 
    ```bash
-   npm view @scottluskcis/outport
+   npm view @scottluskcis/export-toolkit
    ```
 
    Should show the new version.
 
 2. **Visit npm Package Page**:
-   - Go to: https://www.npmjs.com/package/@scottluskcis/outport
+   - Go to: https://www.npmjs.com/package/@scottluskcis/export-toolkit
    - Verify the new version is listed
    - Check for the provenance badge (🔒 verified)
 
 3. **Test Installation**:
 
    ```bash
-   npm install @scottluskcis/outport@latest
+   npm install @scottluskcis/export-toolkit@latest
    ```
 
    Or in a test project:
 
    ```bash
    mkdir test-install && cd test-install
    npm init -y
-   npm install @scottluskcis/outport
-   node -e "console.log(require('@scottluskcis/outport'))"
+   npm install @scottluskcis/export-toolkit
+   node -e "console.log(require('@scottluskcis/export-toolkit'))"
    ```
 
 ## Post-Release
@@ -184,7 +184,7 @@ After the workflow completes:
 Check what was actually published:
 
 ```bash
-npm pack @scottluskcis/outport@latest --dry-run
+npm pack @scottluskcis/export-toolkit@latest --dry-run
 ```
 
 This shows the files included in the published package.
@@ -260,7 +260,7 @@ Increment when you make **backward-compatible bug fixes**:
 
 1. **Authentication Error**:
    - Verify `NPM_TOKEN` secret is set correctly
-   - Ensure token has "Read and write" permissions for `@scottluskcis/outport`
+   - Ensure token has "Read and write" permissions for `@scottluskcis/export-toolkit`
    - Check token hasn't expired
 
 2. **Version Already Published**:
@@ -281,7 +281,7 @@ Increment when you make **backward-compatible bug fixes**:
 
 ```bash
 # Unpublish the incorrect version (use sparingly!)
-npm unpublish @scottluskcis/outport@X.Y.Z
+npm unpublish @scottluskcis/export-toolkit@X.Y.Z
 
 # Publish the correct version
 npm version patch
@@ -308,7 +308,7 @@ git push && git push --tags
 
 2. **Deprecate the broken version**:
    ```bash
-   npm deprecate @scottluskcis/outport@X.Y.Z "Critical bug, please upgrade to X.Y.Z+1"
+   npm deprecate @scottluskcis/export-toolkit@X.Y.Z "Critical bug, please upgrade to X.Y.Z+1"
    ```
 
 ## Emergency Contacts
@@ -323,21 +323,21 @@ git push && git push --tags
 npm pack --dry-run
 
 # View package info on npm
-npm view @scottluskcis/outport
+npm view @scottluskcis/export-toolkit
 
 # View specific version
-npm view @scottluskcis/outport@X.Y.Z
+npm view @scottluskcis/export-toolkit@X.Y.Z
 
 # List all published versions
-npm view @scottluskcis/outport versions
+npm view @scottluskcis/export-toolkit versions
 
 # Check latest version
-npm view @scottluskcis/outport version
+npm view @scottluskcis/export-toolkit version
 
 # Test package in a temporary directory
 mkdir /tmp/test-outport && cd /tmp/test-outport
 npm init -y
-npm install @scottluskcis/outport
+npm install @scottluskcis/export-toolkit
 ```
 
 ## Release Frequency