This repository was archived by the owner on Sep 3, 2024. It is now read-only.
[Doc EN]: modules.md review.
#267
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com>
MachinisteWeb
commented
Sep 30, 2017
| - Are a member of an **agile team** that want to set up your project instantly and avoid **re-inventing** the wheel for common tasks like google-analytics for your new project. | ||
| Another point of using modules is that they can be refactored and packaged out of the project and released as npm packages so you can share and use high quality integration and solutions from Nuxt community with no pain! You might interested in modules if you: | ||
|
|
||
| - Are a member of an **agile team** that want to set up your project instantly and avoid **re-inventing** the wheel for common tasks like Google Analytics tools for your new project. | ||
| - Are an **enterprise** company which **quality** and **reusability** is important for your projects. |
There was a problem hiding this comment.
I'm not sure @atinux but the usage of enterprise company is not redundant? Maybe documentation would say enterprise or company?
I always thinking this word was switchable but not additives?
I'm wrong XD?
| Modules are basically **functions** which are called sequentially when booting Nuxt and core awaits for all of them | ||
| to be finished before continue it's job. So they have the chance to customize almost any aspect of Nuxt and thanks to modular design of nuxt itself and Webpack [Tapable](https://github.com/webpack/tapable) technology they can also register hooks | ||
| for certain entry points like builder initialization. | ||
| While developing production grade application using Nuxt, you will find out soon that Nuxt core functionalities are not enough and writing configs and plugins for each project is a repetitive, boring and time consuming job. Also adding every new feature into Nuxt is not possible as it would make it a fat framework. |
There was a problem hiding this comment.
One line Markdown convention.
|
|
||
| Another point of using modules is that they can be refactored and packaged out of the project and released as NPM packages | ||
| so you can share and use high quality integration and solutions from nuxt community with no pain! You might interested in modules if you: | ||
| This was the reason Nuxt introduces a higher order modular system to easily extend the core. Modules are basically **functions** which are called sequentially when booting Nuxt and core awaits for all of them to be finished before continue it's job. So they have the chance to customize almost any aspect of Nuxt and thanks to modular design of Nuxt itself and webpack [Tapable](https://github.com/webpack/tapable) technology they can also register hooks for certain entry points like builder initialization. |
There was a problem hiding this comment.
One line Markdown convention.
|
|
||
| - Are a member of an **agile team** that want to set up your project instantly and avoid **re-inventing** the wheel for common tasks like google-analytics for your new project. | ||
| Another point of using modules is that they can be refactored and packaged out of the project and released as npm packages so you can share and use high quality integration and solutions from Nuxt community with no pain! You might interested in modules if you: | ||
|
|
There was a problem hiding this comment.
Return line Markdown convention.
|
|
||
| **modules/simple.js** | ||
|
|
There was a problem hiding this comment.
Return line Markdown convention.
|
|
||
| **module.js** | ||
|
|
||
| ```js | ||
| module.exports = function (moduleOptions) { | ||
| if (moduleOptions.fontAwesome !== false) { | ||
| // Add font-awesome | ||
| // Add Font Awesome |
|
|
||
| **module.js** | ||
|
|
||
| ```js | ||
| module.exports = function (moduleOptions) { | ||
| this.extendBuild((config, { isClient, isServer }) => { | ||
| // .foo Loader | ||
| // `.foo` Loader |
There was a problem hiding this comment.
Tick in comment
| @@ -305,7 +287,7 @@ module.exports = function () { | |||
|
|
|||
| // Add hook for build | |||
| this.nuxt.plugin('build', async builder => { | |||
| // This Will be called once when builder created | |||
| // This will be called once when builder created | |||
There was a problem hiding this comment.
remove capital
| @@ -315,12 +297,9 @@ module.exports = function () { | |||
|
|
|||
| // Add hook for generate | |||
| this.nuxt.plugin('generate', async generator => { | |||
| // This Will be called when a nuxt generate starts | |||
| // This will be called when a Nuxt generate starts | |||
There was a problem hiding this comment.
remove capital
| <p class="Alert">There are many many more hooks and possibilities for modules. Please refer to [Nuxt Internals](/api/internals) to learn more about Nuxt internal API.</p> |
There was a problem hiding this comment.
One line markdown convention
Signed-off-by: Bruno Lesieur <bruno.lesieur@gmail.com>
|
😃 |
|
I agree, if we can avoid talknig about entreprise or company, it's nicer! Merging, thanks @haeresis 👏 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In our French translation/review we have changed some consistent things, so we suggest you do the same in the original documentation.
More details in comments.
Do not hesitate to set back the original behavior for some changes if you think they do not make sense.