universal-devkit v1.0.6

Universal DevKit

A command-line tool designed to streamline the setup process for essential development tools. It simplifies the configuration of popular tools used for code formatting, linting, version control, and many more.

Best for TypeScript based React or Nextjs projects.

Badges from Shields

Table of Contents

1. Why UDK?
2. Available Tools
3. Usage
   • Express Setup
   • Custom Setup
   • Scripts
   • Key Pointers
4. Contributors
5. Third-party Tools

Why UDK?

There are a couple of reasons why should consider using this tool.

1. Setting up development environments, adopting the best tools and practices is a painful and arduous job as you have to go through a ton of documentation and/or you are unsure of what and which tools to include in your project.
2. The most obvious problem is the time it takes for the "so called setup".

UDK provides instant setup of your favorite tools, installs the required dependencies, adds the necessary scripts and voila, your setup is ready!

Available Tools

1. Code Formatting
   • Prettier
   • ESLint
   • Stylelint
2. Automation
   • Husky
   • Lint-Staged
3. Version Control and Release Management
   • Commitlint
   • Commitizen
4. IDE Configuration
   • VSCode
   • EditorConfig

Usage

Run the below command:

npx universal-devkit@latest

You will then be asked the following prompt:

Choose the setup you want to go with:
- Express Setup
- Custom Setup

Express Setup

The Express Setup offers a hassle-free, ready-to-go configuration for essential development tools. It includes a predefined set of popular tools configured with the best industry settings. This setting is recommended for new projects or when you prefer a swift, standardized setup.

Custom Setup

Custom Setup provides flexibility, allowing you to cherry-pick specific tools based on your project's requirements. It's ideal for existing projects or when you prefer selecting individual tools and configuring them according to your needs.

Scripts

The scripts can be used with your favorite package managers (npm, yarn and pnpm). Here are the scripts available for you to use:

1. Code Formatting

   • to run prettier

   npm run prettify

   • to run eslint

   npm run lint

   • to fix lint issues

   npm run lint:fix

   • to run stylelint

   npm run lint-css

   • to run lint:fix, lint-css and prettify (comes with express setup)

   npm run format

2. Version Control

   • the new commit command instead of git commit (comes with commitizen)

   npm run commit

Few Things To Keep In Mind

1. If you choose a tool and that tool is already configured in your project, then it may get overwritten with the new configuration. You will see this warning when you use this tool.
2. In express setup, the code formatting (eslint, prettier, stylelint) is automated with the help of lint-staged and husky when you commit your code.
3. eslint setup is very web development (React) and TypeScript specific. Support for nodejs based tools will be added soon.

Contributors

I would appreciate a ton of feedback and help at the same time to improve on existing limitations and ofcourse, to add more to this.

Third-party Tools

Special mention to the third-party tools that I have used to build the cli:

1. Clack - helped me build the beautiful cli interface easily.
2. ShellArtist - helped me create UDK ASCII Art and write other beautiful logs easily.