From b99e1888086502c38411c2ba2637fd36ac111478 Mon Sep 17 00:00:00 2001 From: Alper Ebicoglu Date: Tue, 7 Aug 2018 11:43:00 +0300 Subject: [PATCH] Updated docs (grammar fixes) --- .../Client-Side-Package-Management.md | 23 ++++++++++--------- 1 file changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/AspNetCore/Client-Side-Package-Management.md b/docs/AspNetCore/Client-Side-Package-Management.md index 8eba440fe4..56760caf9b 100644 --- a/docs/AspNetCore/Client-Side-Package-Management.md +++ b/docs/AspNetCore/Client-Side-Package-Management.md @@ -1,8 +1,9 @@ + ## ASP.NET Core MVC Client Side Package Management -ABP framework can work any type of client side package management system. Even you can decide to use nothing and manually manage your dependencies. +ABP framework can work with any type of client side package management systems. You can even decide to use no package management system and manage your dependencies manually. -However, ABP framework best works with **NPM/Yarn**. It provides tools to make it easier to work with and built-in modules are configured to work with NPM/Yarn by default. +However, ABP framework works best with **NPM/Yarn**. By default, built-in modules are configured to work with NPM/Yarn. Finally, we suggest the [**Yarn**](https://yarnpkg.com/) over the NPM since it's faster, stable and also compatible with the NPM. @@ -10,7 +11,7 @@ Finally, we suggest the [**Yarn**](https://yarnpkg.com/) over the NPM since it's ABP is a modular platform. Every developer can create modules and the modules should work together in a **compatible** and **stable** state. -One challenge is the **versions of the depended NPM packages**. What if two different module use the same JavaScript library but its different (and potentially incompatible) versions. +One challenge is the **versions of the dependant NPM packages**. What if two different modules use the same JavaScript library but its different (and potentially incompatible) versions. To solve the versioning problem, we created a **standard set of packages** those depends on some common third-party libraries. Some example packages are [@abp/jquery](https://www.npmjs.com/package/@abp/jquery), [@abp/bootstrap](https://www.npmjs.com/package/@abp/bootstrap) and [@abp/font-awesome](https://www.npmjs.com/package/@abp/font-awesome). You can see the **list of packages** from the [Github repository](https://github.com/volosoft/abp/tree/master/npm/packs). @@ -19,7 +20,7 @@ The benefit of a **standard package** is: * It depends on a **standard version** of a package. Depending on this package is **safe** because all modules depend on the same version. * It contains the gulp task to copy library resources (js, css, img... files) from the **node_modules** folder to **wwwroot/libs** folder. See the *Mapping The Library Resources* section for more. -Depending on a standard package is easy. Just add it to your **package.json** file as you normally add a package. Example: +Depending on a standard package is easy. Just add it to your **package.json** file like you normally do. Example: ````json { @@ -40,7 +41,7 @@ After depending on a NPM package, all you should do is to run the **yarn** comma yarn ```` -You can instead use the `npm install` but the [Yarn](https://yarnpkg.com/) is suggested as mentioned before. +Alternatively, you can use `npm install` but [Yarn](https://yarnpkg.com/) is suggested as mentioned before. #### Package Contribution @@ -58,15 +59,15 @@ See current standard packages for examples. Using NPM packages and NPM/Yarn tool is the de facto standard for client side libraries. NPM/Yarn tool creates a **node_modules** folder in the root folder of your web project. -Next challenge is copying needed resources (js, css, img... files) from the node_modules into a folder inside the **wwwroot** folder to make it accessible to the clients/browsers. +Next challenge is copying needed resources (js, css, img... files) from the `node_modules` into a folder inside the **wwwroot** folder to make it accessible to the clients/browsers. -ABP defines a [Gulp](https://gulpjs.com/) based task to **copy resources** from **node_modules** to **wwwroot/libs** folder. Each **standard package** (see the *@ABP NPM Packages* section) defines the mapping for its own files. So, most of times, you only configure dependencies. +ABP defines a [Gulp](https://gulpjs.com/) based task to **copy resources** from **node_modules** to **wwwroot/libs** folder. Each **standard package** (see the *@ABP NPM Packages* section) defines the mapping for its own files. So, most of the time, you only configure dependencies. The **startup templates** are already configured to work all these out of the box. This section will explain the configuration options. #### Resource Mapping Definition File -An module should define a JavaScript file named `abp.resourcemapping.js` which is formatted as in the example below: +A module should define a JavaScript file named `abp.resourcemapping.js` which is formatted as in the example below: ````js module.exports = { @@ -83,7 +84,7 @@ module.exports = { } ```` -* **aliases** section defines standard aliases (placeholders) those can be used in the mapping paths. **@node_modules** and **@libs** are required (by the standard packages), you can define your own aliases to reduce duplication. +* **aliases** section defines standard aliases (placeholders) that can be used in the mapping paths. **@node_modules** and **@libs** are required (by the standard packages), you can define your own aliases to reduce duplication. * **clean** section is a list of folders to clean before copying the files. * **mappings** section is a list of mappings of files/folders to copy. This example does not copy any resource itself, but depends on a standard package. @@ -104,11 +105,11 @@ Once you properly configure the `abp.resourcemapping.js` file, you can run the g gulp ```` -When you run the gulp, all packages will copy their own resources into the **wwwroot/libs** folder. Running yarn & gulp again is only necessary if you make a change in your dependencies in the **package.json** file. +When you run the `gulp`, all packages will copy their own resources into the **wwwroot/libs** folder. Running `yarn & gulp` is only necessary if you make a change in your dependencies in the **package.json** file. > When you run the Gulp command, dependencies of the application are resolved using the package.json file. The Gulp task automatically discovers and maps all resources from all dependencies (recursively). #### See Also * [Bundling & Minification](Bundling-Minification.md) -* [Theming](Theming.md) \ No newline at end of file +* [Theming](Theming.md)