ctrlshiftleft/docs/PUBLISHING.md

AI-powered toolkit for embedding QA and security testing into development workflows

# Publishing ctrl.shift.left to NPM

This document outlines the process for publishing the ctrl.shift.left package to NPM.

## Prerequisites

1. You need an NPM account. Register at [npmjs.com](https://www.npmjs.com) if you don't have one.
2. You need to be logged in via the terminal: `npm login`
3. Ensure you have appropriate permissions to publish under the package name `ctrlshiftleft`

## Publishing Steps

1. **Prepare the Package**
   ```bash
   # Run the package preparation script
   cd scripts
   node prepare-npm-package.js
   ```

2. **Test the Package Locally (Optional)**
   ```bash
   # In the npm-package directory
   cd npm-package
   npm pack
   
   # Then in your test project
   npm install /path/to/ctrlshiftleft-1.1.0.tgz
   ```

3. **Publish to NPM**
   ```bash
   # In the npm-package directory
   cd npm-package
   npm publish
   ```

4. **Verify the Publication**
   ```bash
   # Install your published package
   npm install -g ctrlshiftleft
   
   # Verify the installation
   ctrlshiftleft --version
   ```

## Publishing a New Version

1. **Update Version Number**
   Update the version in `package.json` following semantic versioning:
   - Patch (1.1.0 → 1.1.1): Bug fixes
   - Minor (1.1.0 → 1.2.0): New features, backward compatible
   - Major (1.1.0 → 2.0.0): Breaking changes

2. **Update Changelog**
   Update `CHANGELOG.md` with the new version and changes.

3. **Run the Preparation Script**
   ```bash
   cd scripts
   node prepare-npm-package.js
   ```

4. **Publish Again**
   ```bash
   cd npm-package
   npm publish
   ```

## Private Scoped Packages (Alternative)

If you prefer to publish under your own npm scope:

1. **Change the package name**
   ```json
   {
     "name": "@yourscope/ctrlshiftleft",
     "version": "1.1.0",
     ...
   }
   ```

2. **Publish as a scoped package**
   ```bash
   cd npm-package
   npm publish --access public
   ```

With a scoped package, users would install with:
```bash
npm install -g @yourscope/ctrlshiftleft
```