🏄🏻 A collection of opinionated configurations for a React project in typescript for presetter

•   Quick Start   •   Project Structure   •   Customization   •   Scripts   •

Features

presetter-preset-react is an opinionated preset for you to setup a React project in a fraction of time you usually take via presetter.

• ✨ TSX support
• 🧪 @testing-library/react
• 📝 Recommended rules from eslint-plugin-react

Quick Start

FULL DOCUMENTATION IS AVAILABLE HERE

1. Bootstrap your project with presetter-preset-esm & presetter-preset-react

npx presetter use presetter-preset presetter-preset-react

That's. One command and you're set.

2. Develop and run life cycle scripts provided by the preset

At this point, all development packages specified in the preset are installed, and now you can try to run some example life cycle scripts (e.g. run prepare).

Project Structure

After installation, your project file structure should resemble the following or with more configuration files if you also installed other presets such as presetter-preset-esm.

Implement your business logic under source and prepare tests under spec. The .d.ts files are handy type definitions for you to import .css or image files in typescript.

TIPS You can always change the source directory to other (e.g. src) by setting the source variable in .presetterrc.json. See the customization section below for more details.

(root)
 ├─ .eslintrc.json
 ├─ .git
 ├─ .presetterrc.json
 ├─ node_modules
 ├─ source
 │   ├─ <folders>
 │   ├─ index.ts
 │   ├─ (auxiliary).ts
 ├─ spec
 │   ├─ *.spec.ts
 ├─ types
 │   ├─ image.d.ts
 │   ├─ style.d.ts
 │   ├─ (type).d.ts
 ├─ package.json
 └─ tsconfig.json

Customization

By default, this preset exports a handy configuration set for a React project written in typescript. But you can further customize (either extending or replacing) the configuration by specifying the change in the config file (.presetterrc or .presetterrc.json).

These settings are available in the config field in the config file. For directories, the setting is specified in the variable field.

The structure of .presetterrc should follow the interface below:

interface PresetterRC {
  /** name(s) of the preset e.g. presetter-preset-react */
  name: string | string[];
  /** additional configuration passed to the preset for generating the configuration files */
  config?: {
    //  ┌─ configuration for other tools via other presets (e.g. presetter-preset-esm)
    // ...

    /** configuration to be merged with .eslintrc */
    eslint?: Record<string, unknown>;
    /** configuration to be merged with tsconfig.json */
    tsconfig?: Record<string, unknown>;
    /** variables to be substituted in templates */
    variable?: {
      /** the directory containing all source code (default: source) */
      source?: string;
      /** the directory containing all typing files (default: types) */
      types?: string;
      /** the directory containing all output tile (default: source) */
      output?: string;
    };
  };
}