Xfive Coding Standards Configuration

Setup popular frameworks with Xfive recommended configuration for ESLint, Stylelint, Prettier and others. Our tool provides one command that automatically adjusts your project to help you write clean, readable and maintainable code.

Setup

Follow the instructions specific to your project.

Validated 2024-03-28 with [email protected]

# create project directory (or clone empty repository) and cd into it first
npx create-next-app@^14 . --ts --eslint --app --use-npm --no-tailwind --no-src-dir --import-alias '~/*'
npx @xfive/coding-standards@latest

Validated 2024-03-28 with [email protected]

We have not tested impact of many of the options available during project creation on our configuration.

1. Create project with npm create vue@^3. Answer questions as follows, for questions not mentioned below answer based on your preferences:

   √ Add ESLint for code quality? ... Yes
   √ Add Prettier for code formatting? ... No

2. Go to created project directory

3. Create repository and commit initial files

4. Run npx @xfive/coding-standards@latest

Validated 2024-03-28 with [email protected]

1. Create project directory (or clone empty repository) and cd into it first.
2. Create project with npx nuxi@^3 init ..
3. Run npx @xfive/coding-standards@latest

Validated 2024-03-28 with @angular/[email protected]

1. Create project with npm init '@angular'.
2. Go to created project directory
3. Add ESLint with npx @angular/cli@latest add @angular-eslint/schematics
4. Run npx @xfive/coding-standards@latest

Validated 2024-03-28

Run npx @xfive/coding-standards@latest to adjust project to Xfive coding standards. This will install all required dependencies and add configuration files. We'll do it on best effort basis, so please check if everything is correct.