139 lines
10 KiB
Plaintext
139 lines
10 KiB
Plaintext
# Task ID: 63
|
|
# Title: Add pnpm Support for the Taskmaster Package
|
|
# Status: done
|
|
# Dependencies: None
|
|
# Priority: medium
|
|
# Description: Implement full support for pnpm as an alternative package manager in the Taskmaster application, ensuring users have the exact same experience as with npm when installing and managing the package. The installation process, including any CLI prompts or web interfaces, must serve the exact same content and user experience regardless of whether npm or pnpm is used. The project uses 'module' as the package type, defines binaries 'task-master' and 'task-master-mcp', and its core logic resides in 'scripts/modules/'. The 'init' command (via scripts/init.js) creates the directory structure (.cursor/rules, scripts, tasks), copies templates (.env.example, .gitignore, rule files, dev.js), manages package.json merging, and sets up MCP config (.cursor/mcp.json). All dependencies are standard npm dependencies listed in package.json, and manual modifications are being removed.
|
|
# Details:
|
|
This task involves:
|
|
|
|
1. Update the installation documentation to include pnpm installation commands (e.g., `pnpm add taskmaster`).
|
|
|
|
2. Ensure all package scripts are compatible with pnpm's execution model:
|
|
- Review and modify package.json scripts if necessary
|
|
- Test script execution with pnpm syntax (`pnpm run <script>`)
|
|
- Address any pnpm-specific path or execution differences
|
|
- Confirm that scripts responsible for showing a website or prompt during install behave identically with pnpm and npm
|
|
|
|
3. Create a pnpm-lock.yaml file by installing dependencies with pnpm.
|
|
|
|
4. Test the application's installation and operation when installed via pnpm:
|
|
- Global installation (`pnpm add -g taskmaster`)
|
|
- Local project installation
|
|
- Verify CLI commands work correctly when installed with pnpm
|
|
- Verify binaries `task-master` and `task-master-mcp` are properly linked
|
|
- Ensure the `init` command (scripts/init.js) correctly creates directory structure and copies templates as described
|
|
|
|
5. Update CI/CD pipelines to include testing with pnpm:
|
|
- Add a pnpm test matrix to GitHub Actions workflows
|
|
- Ensure tests pass when dependencies are installed with pnpm
|
|
|
|
6. Handle any pnpm-specific dependency resolution issues:
|
|
- Address potential hoisting differences between npm and pnpm
|
|
- Test with pnpm's strict mode to ensure compatibility
|
|
- Verify proper handling of 'module' package type
|
|
|
|
7. Document any pnpm-specific considerations or commands in the README and documentation.
|
|
|
|
8. Verify that the `scripts/init.js` file works correctly with pnpm:
|
|
- Ensure it properly creates `.cursor/rules`, `scripts`, and `tasks` directories
|
|
- Verify template copying (`.env.example`, `.gitignore`, rule files, `dev.js`)
|
|
- Confirm `package.json` merging works correctly
|
|
- Test MCP config setup (`.cursor/mcp.json`)
|
|
|
|
9. Ensure core logic in `scripts/modules/` works correctly when installed via pnpm.
|
|
|
|
This implementation should maintain full feature parity and identical user experience regardless of which package manager is used to install Taskmaster.
|
|
|
|
# Test Strategy:
|
|
1. Manual Testing:
|
|
- Install Taskmaster globally using pnpm: `pnpm add -g taskmaster`
|
|
- Install Taskmaster locally in a test project: `pnpm add taskmaster`
|
|
- Verify all CLI commands function correctly with both installation methods
|
|
- Test all major features to ensure they work identically to npm installations
|
|
- Verify binaries `task-master` and `task-master-mcp` are properly linked and executable
|
|
- Test the `init` command to ensure it correctly sets up the directory structure and files as defined in scripts/init.js
|
|
|
|
2. Automated Testing:
|
|
- Create a dedicated test workflow in GitHub Actions that uses pnpm
|
|
- Run the full test suite using pnpm to install dependencies
|
|
- Verify all tests pass with the same results as npm
|
|
|
|
3. Documentation Testing:
|
|
- Review all documentation to ensure pnpm commands are correctly documented
|
|
- Verify installation instructions work as written
|
|
- Test any pnpm-specific instructions or notes
|
|
|
|
4. Compatibility Testing:
|
|
- Test on different operating systems (Windows, macOS, Linux)
|
|
- Verify compatibility with different pnpm versions (latest stable and LTS)
|
|
- Test in environments with multiple package managers installed
|
|
- Verify proper handling of 'module' package type
|
|
|
|
5. Edge Case Testing:
|
|
- Test installation in a project that uses pnpm workspaces
|
|
- Verify behavior when upgrading from an npm installation to pnpm
|
|
- Test with pnpm's various flags and modes (--frozen-lockfile, --strict-peer-dependencies)
|
|
|
|
6. Performance Comparison:
|
|
- Measure and document any performance differences between package managers
|
|
- Compare installation times and disk space usage
|
|
|
|
7. Structure Testing:
|
|
- Verify that the core logic in `scripts/modules/` is accessible and functions correctly
|
|
- Confirm that the `init` command properly creates all required directories and files as per scripts/init.js
|
|
- Test package.json merging functionality
|
|
- Verify MCP config setup
|
|
|
|
Success criteria: Taskmaster should install and function identically regardless of whether it was installed via npm or pnpm, with no degradation in functionality, performance, or user experience. All binaries should be properly linked, and the directory structure should be correctly created.
|
|
|
|
# Subtasks:
|
|
## 1. Update Documentation for pnpm Support [done]
|
|
### Dependencies: None
|
|
### Description: Revise installation and usage documentation to include pnpm commands and instructions for installing and managing Taskmaster with pnpm. Clearly state that the installation process, including any website or UI shown, is identical to npm. Ensure documentation reflects the use of 'module' package type, binaries, and the init process as defined in scripts/init.js.
|
|
### Details:
|
|
Add pnpm installation commands (e.g., `pnpm add taskmaster`) and update all relevant sections in the README and official docs to reflect pnpm as a supported package manager. Document that any installation website or prompt is the same as with npm. Include notes on the 'module' package type, binaries, and the directory/template setup performed by scripts/init.js.
|
|
|
|
## 2. Ensure Package Scripts Compatibility with pnpm [done]
|
|
### Dependencies: 63.1
|
|
### Description: Review and update package.json scripts to ensure they work seamlessly with pnpm's execution model. Confirm that any scripts responsible for showing a website or prompt during install behave identically with pnpm and npm. Ensure compatibility with 'module' package type and correct binary definitions.
|
|
### Details:
|
|
Test all scripts using `pnpm run <script>`, address any pnpm-specific path or execution differences, and modify scripts as needed for compatibility. Pay special attention to any scripts that trigger a website or prompt during installation, ensuring they serve the same content as npm. Validate that scripts/init.js and binaries are referenced correctly for ESM ('module') projects.
|
|
|
|
## 3. Generate and Validate pnpm Lockfile [done]
|
|
### Dependencies: 63.2
|
|
### Description: Install dependencies using pnpm to create a pnpm-lock.yaml file and ensure it accurately reflects the project's dependency tree, considering the 'module' package type.
|
|
### Details:
|
|
Run `pnpm install` to generate the lockfile, check it into version control, and verify that dependency resolution is correct and consistent. Ensure that all dependencies listed in package.json are resolved as expected for an ESM project.
|
|
|
|
## 4. Test Taskmaster Installation and Operation with pnpm [done]
|
|
### Dependencies: 63.3
|
|
### Description: Thoroughly test Taskmaster's installation and CLI operation when installed via pnpm, both globally and locally. Confirm that any website or UI shown during installation is identical to npm. Validate that binaries and the init process (scripts/init.js) work as expected.
|
|
### Details:
|
|
Perform global (`pnpm add -g taskmaster`) and local installations, verify CLI commands, and check for any pnpm-specific issues or incompatibilities. Ensure any installation UIs or websites appear identical to npm installations, including any website or prompt shown during install. Test that binaries 'task-master' and 'task-master-mcp' are linked and that scripts/init.js creates the correct structure and templates.
|
|
|
|
## 5. Integrate pnpm into CI/CD Pipeline [done]
|
|
### Dependencies: 63.4
|
|
### Description: Update CI/CD workflows to include pnpm in the test matrix, ensuring all tests pass when dependencies are installed with pnpm. Confirm that tests cover the 'module' package type, binaries, and init process.
|
|
### Details:
|
|
Modify GitHub Actions or other CI configurations to use pnpm/action-setup, run tests with pnpm, and cache pnpm dependencies for efficiency. Ensure that CI covers CLI commands, binary linking, and the directory/template setup performed by scripts/init.js.
|
|
|
|
## 6. Verify Installation UI/Website Consistency [done]
|
|
### Dependencies: 63.4
|
|
### Description: Ensure any installation UIs, websites, or interactive prompts—including any website or prompt shown during install—appear and function identically when installing with pnpm compared to npm. Confirm that the experience is consistent for the 'module' package type and the init process.
|
|
### Details:
|
|
Identify all user-facing elements during the installation process, including any website or prompt shown during install, and verify they are consistent across package managers. If a website is shown during installation, ensure it appears the same regardless of package manager used. Validate that any prompts or UIs triggered by scripts/init.js are identical.
|
|
|
|
## 7. Test init.js Script with pnpm [done]
|
|
### Dependencies: 63.4
|
|
### Description: Verify that the scripts/init.js file works correctly when Taskmaster is installed via pnpm, creating the proper directory structure and copying all required templates as defined in the project structure.
|
|
### Details:
|
|
Test the init command to ensure it properly creates .cursor/rules, scripts, and tasks directories, copies templates (.env.example, .gitignore, rule files, dev.js), handles package.json merging, and sets up MCP config (.cursor/mcp.json) as per scripts/init.js.
|
|
|
|
## 8. Verify Binary Links with pnpm [done]
|
|
### Dependencies: 63.4
|
|
### Description: Ensure that the task-master and task-master-mcp binaries are properly defined in package.json, linked, and executable when installed via pnpm, in both global and local installations.
|
|
### Details:
|
|
Check that the binaries defined in package.json are correctly linked in node_modules/.bin when installed with pnpm, and that they can be executed without errors. Validate that binaries work for ESM ('module') projects and are accessible after both global and local installs.
|
|
|