DevKit

DevKit is a library designed to provide the necessary resources to manage and extend the Nizza and Perant monorepos. Featuring a reusable Vite.js codebase, it simplifies the creation of vite.config.ts files for every library and application within the monorepo. Additionally, it includes several NX executors to aid in performing tasks within apps and libs efficiently.

Key Features

• Simplified Vite.js Configuration: Easily generate vite.config.ts files leveraging our reusable codebase.
• Custom NX Executors: Automate common tasks with our specially designed executors for our monorepos.

Executors

DevKit includes a variety of executors to automate and ease the handling of tasks within your project, such as:

• Environments: Generates environment files (environment.ts, environment.local.ts, etc.) in the src/environments directory, utilizing the project's configuration.
• VTEX Link: Links a package to a VTEX project, facilitating integration and deployment of changes.
• Publish: Automates the process of publishing packages to npm, including version checks and support for dry run testing.
• Update Executors File: Updates paths in the executors.json file to point to the correct locations after changes in the project structure.
• Deploy: Deploys project assets to an AWS S3 bucket and invalidates CloudFront distribution cache.

Usage

To use the executors included in DevKit, you don't need NX installed globally due to the inclusion of an nx script in your root package.json. Each executor is configured and run through the nx.json or via specific NX commands using pnpm.

Working with DevKit

DevKit streamlines the development and management processes within the Nizza and Perant monorepos. Here are the key commands you can use:

Building

pnpm nx run devkit:build:dev
pnpm nx run devkit:build:prod

Linting

pnpm nx run devkit:lint

Cleaning

pnpm nx run devkit:clean

Versioning

Manage your project versions effectively.

pnpm nx run devkit:version

Environment-Specific Commands

DevKit supports environment-specific commands for dev, staging, and prod, allowing easy management and deployment across different development stages.

For example, to deploy your project in a production environment:

pnpm nx run devkit:deploy:prod