In this blog post, Pedro explains why we rewrote Shopify CLI into Node instead of Ruby, the tradeoffs that came with the decision, the principles we embraced in this new iteration, and the challenges and ideas ahead of us to explore.
Overview
The article discusses the complete rewrite of Shopify's CLI from Ruby to Node.js, focusing on enhancing the developer experience. It outlines the reasons for the transition, the principles adopted in the new implementation, and the challenges faced during the process.
What You'll Learn
1
How to transition a CLI from Ruby to Node.js effectively
2
Why using TypeScript improves code quality and developer experience
3
When to implement a monorepo structure for better project management
4
How to ensure cross-OS compatibility in CLI applications
5
How to leverage community frameworks like oclif for building CLIs
Prerequisites & Requirements
- Familiarity with command line interfaces and Node.js
- Experience with TypeScript and npm packages(optional)
Key Questions Answered
What motivated Shopify to rewrite its CLI from Ruby to Node?
Shopify decided to rewrite its CLI from Ruby to Node due to increasing system requirements, the need for a better developer experience, and the desire for a unified CLI that could support various development workflows without requiring multiple runtimes. The shift aligns with the growing reliance on JavaScript and Node in their ecosystem.
How does the new Node CLI improve developer experience?
The new Node CLI enhances developer experience by providing a modular architecture, improved cross-OS support, and a consistent interface that aligns with modern development practices. It also allows for easier contributions from internal teams familiar with JavaScript.
What are the key principles adopted in building the new CLI?
Key principles include creating a foundation for consistency, ensuring cross-OS support, embracing functional programming, implementing an end-to-end testing strategy, and leveraging TypeScript for better type safety and developer ergonomics. These principles aim to streamline the development process and improve overall user experience.
What challenges did Shopify face during the CLI transition?
During the transition, Shopify faced challenges such as maintaining consistency across different development environments, ensuring compatibility with existing Ruby-based workflows, and managing the complexity of a monorepo structure. These challenges required careful planning and execution to avoid fragmentation and ensure a seamless developer experience.
Technologies & Tools
Some links below are affiliate links. We may earn a commission if you make a purchase.
Backend
Node.js
Used as the runtime environment for the new Shopify CLI.
Programming Language
Typescript
Used to improve code quality and developer experience through strong typing.
Framework
Oclif
Framework used for building the CLI, providing tools and APIs for modular architecture.
Key Actionable Insights
1Adopting a monorepo structure can significantly simplify project management and improve collaboration among teams.By consolidating all components into a single repository, teams can make changes that span multiple packages more easily, reducing the overhead of managing multiple repositories and enhancing the overall development workflow.
2Leveraging TypeScript can enhance code quality and reduce bugs by providing strong typing and better tooling support.Using TypeScript allows developers to catch errors at compile time rather than runtime, leading to a more robust codebase and a smoother development experience.
3Implementing an end-to-end testing strategy is crucial for ensuring that workflows function correctly across different environments.E2E tests help identify issues that unit tests might miss, providing confidence that the CLI performs as expected in real-world scenarios.
4Utilizing community frameworks like oclif can accelerate CLI development and provide best practices out of the box.These frameworks offer pre-built functionalities and conventions that can save development time and improve the overall quality of the CLI.
Common Pitfalls
1
Failing to ensure cross-OS compatibility can lead to inconsistent developer experiences and increased support issues.
This often happens when developers test only on their primary OS, neglecting to verify functionality on others. To avoid this, implement a comprehensive testing strategy that includes all target operating systems.
2
Not adopting a consistent coding standard can result in fragmented codebases that are difficult to maintain.
Without clear patterns and conventions, contributions can vary widely in quality and style. Establishing a shared set of guidelines helps maintain consistency and improves collaboration.
Related Concepts
CLI Development Best Practices
Typescript For Javascript Developers
Modular Architecture In Software Design
End-to-end Testing Strategies