presetter-preset

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

•   Quick Start   •   Project Structure   •   Customisation   •   Scripts   •

In addition to a set of opinionated configuration files, it also provides a number of essential lifecycle and helper commands.

Quick Start

FULL DOCUMENTATION IS AVAILABLE HERE

• Bootstrap your project with a preset (e.g. presetter-preset)

npx presetter use <preset package name>

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

• 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 installing this preset, your project file structure should look like the following.

Implement your business logic under source and prepare tests under spec.

(root)
 ├─ .babelrc
 ├─ .eslintrc.json
 ├─ .git
 ├─ .gitignore
 ├─ .jestrc.json
 ├─ .npmignore
 ├─ .prettierrc.json
 ├─ .preseterrc.json
 ├─ node_modules
 ├─ source
 │   ├─ <folders>
 │   ├─ index.ts
 │   ├─ (auxillary).ts
 ├─ spec
 │   ├─ *.spec.ts
 ├─ package.json
 ├─ tsconfig.json
 └─ tsconfig.build.json

Customisation

By default, this preset exports a handy configuration set for a nodejs project. But you can further customise (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 directory field, while configuration for other tools like babel and eslint are available in corresponding fields.

The structure of .presetterrc must be the following:

interface PresetterRC {
  /** name of the preset e.g. presetter-preset */
  name: string;
  /** additional configuration passed to the preset for generating the configuration files */
  config?: {
    /** configuration to be merged with .babelrc */
    babel?: Record<string, unknown>;
    /** configuration to be merged with .eslintrc */
    eslint?: Record<string, unknown>;
    /** configuration to be merged with .jestrc */
    jest?: Record<string, unknown>;
    /** patterns to be added to .gitignore */
    gitignore?: string[];
    /** patterns to be added to .npmignore */
    npmignore?: string[];
    /** configuration to be merged with .presetterrc */
    prettier?: Record<string, unknown>;
    /** configuration to be merged with tsconfig.json */
    tsconfig?: Record<string, unknown>;
    /** relative path to root directories for different file types */
    directory?: {
      /** the directory containing the whole repository (default: .) */
      root?: string;
      /** 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;
      /** the directory containing all test files (default: spec) */
      test?: string;
    };
  };
}

Script Template Summary

• run build: Transpile source code from typescript and replace any mapped paths
• run clean: Clean up any previously transpiled code
• run develop -- <file path>: Create a service that run the specified file whenever the source has changed
• run test: Run all tests
• run watch: Rerun all tests whenever the source has change
• run coverage: Run all test with coverage report
• run release: Bump the version and automatically generate a change log
• run release -- --prerelease <tag>: Release with a prerelease tag

Notes

• Since git 2.32 (released on 2020-06-06), git no longer follows .gitignore as a symlink. Therefore, the packaged .gitignore will be ignored. To make it work again, overwrite the .gitignore with a file list the standard way. You may want to copy our template here.