Skip to content

Commit

Permalink
docs: fix various spelling mistakes in Javascript doc and deploy scripts
Browse files Browse the repository at this point in the history
Reviewed in foundation#11516
  • Loading branch information
ncoden committed Sep 27, 2018
1 parent 9ff3e50 commit dbefc0f
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
8 changes: 4 additions & 4 deletions docs/pages/javascript.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Know that they all require `foundation.core.js` to be loaded *first*. Some plugi

### Import in JavaScript

By default, Foundation is exported as [UMD modules](http://bob.yexley.net/umd-javascript-that-runs-anywhere/). This means that Foundation and its plugins can be imported and used in any JavaScript environnement.
By default, Foundation is exported as [UMD modules](http://bob.yexley.net/umd-javascript-that-runs-anywhere/). This means that Foundation and its plugins can be imported and used in any JavaScript environment.

For example with [ES6](https://github.com/lukehoban/es6features#readme) (the ESM format):
```js
Expand All @@ -65,10 +65,10 @@ var $dropdown = new Dropdown('#mydropdown');

#### Available formats

Foundation is proposed in bundles of various module formats so you can pick the one that match the best your needs. If you don't know these terms yet, take a look at this [10-minute introduction to module formats in JavaScript](https://www.jvandemo.com/a-10-minute-primer-to-javascript-modules-module-formats-module-loaders-and-module-bundlers/). You will find in the `dist/js` folder the following bundles:
Foundation is provided in bundles of various module formats so you can pick the one that matches the best your needs. If you don't know these terms yet, take a look at this [10-minute introduction to module formats in JavaScript](https://www.jvandemo.com/a-10-minute-primer-to-javascript-modules-module-formats-module-loaders-and-module-bundlers/). You will find in the `dist/js` folder the following bundles:

* `foundation.js` <span class="label secondary">UMD</span> <span class="label">Default</span><br>
Compatible with most environments and tools (AMD, CJS, ESM...). It works almost everywhere by checking the module format of your environments and then using it, which make the bundle a little heavier.
Compatible with most environments and tools (AMD, CJS, ESM...). It works almost everywhere by checking the module format of your environments and then using it, which makes the bundle a little heavier.

* `foundation.cjs.js` <span class="label secondary">CommonJS</span><br>
Dedicated to Node.js and older bundlers like Browserify or Webpack v1.
Expand All @@ -77,7 +77,7 @@ Foundation is proposed in bundles of various module formats so you can pick the
Everything is transpiled to ES5 but the modules. Dedicated to modern bundlers, like Webpack 2+ or Rollup. They will automatically use this bundle and parse the ES6 modules to remove the unused code (see [tree shaking](#tree-shaking) below).

* `foundation.es6.js` <span class="label secondary">ES6</span> (`esnext` in `package.json`)<br>
Unlike the others bundles, this bundle is not transpiled. It contains all the Foundation sources in ES6 in a single file. Use it if you want to manually transpile it for your own targets.
Unlike the other bundles, this bundle is not transpiled. It contains all the Foundation sources in ES6 in a single file. Use it if you want to manually transpile it for your own targets.

#### Tree Shaking

Expand Down
4 changes: 2 additions & 2 deletions gulp/tasks/deploy.js
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ gulp.task('deploy:dist:files', function() {
// Generates JS bundles and puts them in the dist/ folder.
//
// In addition to the UMD bundle coming from the build task, the following
// formats are generared: CJS, ESM, ES6.
// See "rollup.config.js" for more informations.
// formats are generated: CJS, ESM, ES6.
// See "rollup.config.js" for more information.
//
gulp.task('deploy:dist:bundles', gulp.series(
// Create a subtask for each Rollup config
Expand Down
2 changes: 1 addition & 1 deletion rollup.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ var baseConfig = {
module.exports = [

// UMD
// Compatible with most environements and tools (AMD, CJS, ESM...),
// Compatible with most environments and tools (AMD, CJS, ESM...),
// > Generated with Webpack. See the "javascript:foundation" gulp task.
// > TODO: factorize the assets generation.

Expand Down

0 comments on commit dbefc0f

Please sign in to comment.