From 7f3e8e6870606ce2e9c63189844e36b36c77d16e Mon Sep 17 00:00:00 2001 From: Alvis HT Tang Date: Thu, 30 Sep 2021 18:37:31 +0100 Subject: [PATCH] refactor: rename presetter-preset to presetter-preset-essentials --- .presetterrc.json | 2 +- README.md | 8 ++++---- package.json | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/.presetterrc.json b/.presetterrc.json index e33a3fe..29c6753 100644 --- a/.presetterrc.json +++ b/.presetterrc.json @@ -1,5 +1,5 @@ { - "preset": "presetter-preset", + "preset": "presetter-preset-essentials", "config": { "npmignore": ["!/configs/**", "!/templates/**"] }, diff --git a/README.md b/README.md index 98c731d..ecc4613 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ [**FULL DOCUMENTATION IS AVAILABLE HERE**](https://github.com/alvis/presetter/blob/master/README.md) -1. Bootstrap your project with `presetter-preset` & `presetter-preset-rollup` +1. Bootstrap your project with `presetter-preset-essentials` & `presetter-preset-rollup` ```shell npx presetter use presetter-preset presetter-preset-rollup @@ -72,7 +72,7 @@ For NodeJS to import the correct export, remember to specify the following in yo ## Project Structure -After installing `presetter-preset` & `presetter-preset-rollup`, your project file structure should look like the following or with more configuration file if you also installed `presetter-preset`. +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-essentials`](https://github.com/alvis/presetter/blob/master/packages/preset-essentials). Implement your business logic under `source` and prepare tests under `spec`. @@ -104,11 +104,11 @@ The structure of `.presetterrc` should follow the interface below: ```ts interface PresetterRC { - /** name(s) of the preset e.g. presetter-preset */ + /** name(s) of the preset e.g. presetter-preset-rollup */ 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) + // ┌─ configuration for other tools via other presets (e.g. presetter-preset-essentials) // ... /** additional configuration for rollup */ diff --git a/package.json b/package.json index 2bfafed..205ee1d 100644 --- a/package.json +++ b/package.json @@ -48,6 +48,6 @@ }, "devDependencies": { "presetter": "file:../presetter", - "presetter-preset": "file:../preset" + "presetter-preset-essentials": "file:../preset-essentials" } }