Skip to content

Commit

Permalink
chore: addon -> scaffold
Browse files Browse the repository at this point in the history
  • Loading branch information
evenstensberg committed Jan 3, 2019
1 parent 82c9ea8 commit b0f4a0f
Show file tree
Hide file tree
Showing 10 changed files with 30 additions and 1,364 deletions.
4 changes: 2 additions & 2 deletions INIT.md
Expand Up @@ -18,7 +18,7 @@ Follow given steps to locally setup `webpack-cli init` by installing dependencie
$ npm install --save-dev webpack webpack-cli
```

3. Install `@webpack-cli/init` package to add init addon
3. Install `@webpack-cli/init` package to add init scaffold

```shell
$ npm install --save-dev @webpack-cli/init
Expand All @@ -32,7 +32,7 @@ Follow following steps to setup `webpack-cli init` globally:
$ npm install -g webpack webpack-cli
```

2. Install `@webpack-cli/init` package to add init addon
2. Install `@webpack-cli/init` package to add init scaffold
```shell
$ npm install -g @webpack-cli/init
```
Expand Down
4 changes: 2 additions & 2 deletions README.md
Expand Up @@ -62,9 +62,9 @@ You will answer many questions when running the `init` so webpack CLI can provid

## webpack CLI Scaffolds

With v3 of webpack CLI, we introduced scaffolding as an integral part of the CLI. Our goal is to simplify the creation of webpack configurations for different purposes. Additionally, sharing such solutions with the community is beneficial and with webpack Addon's we want to allow this. We provide `webpack-scaffold` as a utility suite for creating these add-ons. It contains functions that could be of use for creating an addon yourself.
With v3 of webpack CLI, we introduced scaffolding as an integral part of the CLI. Our goal is to simplify the creation of webpack configurations for different purposes. Additionally, sharing such solutions with the community is beneficial and with webpack webpack's we want to allow this. We provide `webpack-scaffold` as a utility suite for creating these add-ons. It contains functions that could be of use for creating an scaffold yourself.

You can read more about [Scaffolding](./SCAFFOLDING.md) or check out the example project [How do I compose a webpack-addon?](https://github.com/ev1stensberg/webpack-addons-demo).
You can read more about [Scaffolding](./SCAFFOLDING.md) or check out the example project [How do I compose a webpack-scaffold?](https://github.com/evenstensberg/webpack-scaffold-demo).

## Contributing and Internal Documentation

Expand Down
6 changes: 3 additions & 3 deletions SCAFFOLDING.md
Expand Up @@ -10,20 +10,20 @@ Before writing a `webpack-cli` scaffold, think about what you're trying to achie

## webpack-scaffold

`webpack-scaffold` is a utility suite for creating addons. It contains functions that could be of use for creating an addon yourself.
`webpack-scaffold` is a utility suite for creating scaffolds. It contains functions that could be of use for creating an scaffold yourself.

## webpack-scaffold-yourpackage

In order for `webpack-cli` to compile your package, it must be available on npm or on your local filesystem. If you are curious about how you can create your very own `scaffold`, please read [How do I compose a
webpack-addon?](https://github.com/ev1stensberg/webpack-addons-demo).
webpack-scaffold?](https://github.com/evenstensberg/webpack-scaffold-demo).

If the package is on npm, its name must have a prefix of `webpack-scaffold`.

If the package is on your local filesystem, it can be named whatever you want. Pass the path to the package.

## API

To create an `addon`, you must create a [`yeoman-generator`](http://yeoman.io/authoring/). Because of that, you can optionally extend your generator to include methods from the [Yeoman API](http://yeoman.io/learning/). Its worth noting that we support all the properties of a regular webpack configuration. In order for us to do this, there's a thing you need to remember.
To create a `scaffold`, you must create a [`yeoman-generator`](http://yeoman.io/authoring/). Because of that, you can optionally extend your generator to include methods from the [Yeoman API](http://yeoman.io/learning/). Its worth noting that we support all the properties of a regular webpack configuration. In order for us to do this, there's a thing you need to remember.

Objects are made using strings, while strings are made using double strings. This means that in order for you to create an string, you have to wrap it inside another string for us to validate it correctly.

Expand Down

0 comments on commit b0f4a0f

Please sign in to comment.