refactor: rename presetter-preset to presetter-preset-essentials

This commit is contained in:
Alvis HT Tang 2021-09-30 18:37:31 +01:00
parent dfebcbe9a5
commit 7f3e8e6870
3 changed files with 6 additions and 6 deletions

View File

@ -1,5 +1,5 @@
{ {
"preset": "presetter-preset", "preset": "presetter-preset-essentials",
"config": { "config": {
"npmignore": ["!/configs/**", "!/templates/**"] "npmignore": ["!/configs/**", "!/templates/**"]
}, },

View File

@ -38,7 +38,7 @@
[**FULL DOCUMENTATION IS AVAILABLE HERE**](https://github.com/alvis/presetter/blob/master/README.md) [**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 ```shell
npx presetter use presetter-preset presetter-preset-rollup 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 ## 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`. 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 ```ts
interface PresetterRC { interface PresetterRC {
/** name(s) of the preset e.g. presetter-preset */ /** name(s) of the preset e.g. presetter-preset-rollup */
name: string | string[]; name: string | string[];
/** additional configuration passed to the preset for generating the configuration files */ /** additional configuration passed to the preset for generating the configuration files */
config?: { 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 */ /** additional configuration for rollup */

View File

@ -48,6 +48,6 @@
}, },
"devDependencies": { "devDependencies": {
"presetter": "file:../presetter", "presetter": "file:../presetter",
"presetter-preset": "file:../preset" "presetter-preset-essentials": "file:../preset-essentials"
} }
} }