-
Notifications
You must be signed in to change notification settings - Fork 276
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
13 changed files
with
48 additions
and
64 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # Sitecore JavaScript Services for Angular | ||
| # Sitecore JavaScript Services Angular Schematics | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains Angular developer code generation schematics. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # Sitecore JavaScript Services for Angular | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains Angular integration components and services for JSS. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services CLI tools | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains the JSS command line interface. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services developer tools | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains developer tooling, such as development proxies and deployment scripts. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,22 +1,6 @@ | ||
| # Sitecore JavaScript Services manifest utilities | ||
| # Sitecore JavaScript Services Manifest | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
|
|
||
| ## Known Issues | ||
| * Incompatible with a `babel` config that uses `babel-preset-env` with the `"modules": false` option, e.g.: | ||
| ``` | ||
| "presets": [ | ||
| [ | ||
| "env", | ||
| { | ||
| "modules": false | ||
| } | ||
| ], | ||
| ] | ||
| ``` | ||
| The issue is that `"modules": false` instructs Babel to _not_ transpile your ES6+ modules to a format like `CommonJS`, which typically allows Webpack to apply tree shaking to your code. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains disconnected-mode manifest generation capabilities. | ||
|
|
||
| Unfortunately, this doesn't play well with manifest generation when you use `babel-register` as a compiler for your manifest spec files. `babel-register` transpiles your spec files on-the-fly and uses whatever Babel configuration it can find. Therefore, if you have a single `.babelrc` file or define your Babel config in `package.json`, then `babel-register` will use that config. And if that config uses `bable-preset-env` with `"modules": false`, then your spec files won't be transpiled. | ||
|
|
||
| The workaround at the moment, assuming you're using Webpack, is to move your Webpack-specific Babel config into your `babel-loader` options. Then use `.babelrc` (or equivalent) for other environments like unit testing and manifest generation. | ||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services proxy library | ||
| # Sitecore JavaScript Services Proxy | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains the headless-mode SSR proxy implementation. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Sitecore JavaScript Services React Native | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. It contains the integration for React Native (services & components). | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services for React.js | ||
| # Sitecore JavaScript Services for React | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains React components and integration for JSS. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services core | ||
| # Sitecore JavaScript Services Tracking | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains APIs to invoke the JSS Tracker to track visitor behaviour. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| # Sitecore JavaScript Services tools for update package generation | ||
| # Sitecore JavaScript Services Import Packages | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains semantics to generate JSS disconnected import packages. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| # Sitecore JavaScript Services for Vue.js | ||
| # Sitecore JavaScript Services for Vue | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains Vue integration and components for JSS. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,6 @@ | ||
| # Sitecore JavaScript Services core | ||
| # Sitecore JavaScript Services | ||
|
|
||
| This module is provided as a part of Sitecore JavaScript Services. | ||
| Please consult LICENSE.txt file for details. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains the core JSS APIs (layout service) and utilities. | ||
|
|
||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. | ||
|
|
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,5 @@ | ||
| # Sitecore JavaScript Services pipeline utilities | ||
| # Sitecore JavaScript Services Pipelines | ||
|
|
||
| ## Known Issues / Limitations | ||
| * Only works with node.js, will not run in browser-targeted code | ||
| * Incompatible with a `babel` config that uses `babel-preset-env` with the `"modules": false` option, e.g.: | ||
| ``` | ||
| "presets": [ | ||
| [ | ||
| "env", | ||
| { | ||
| "modules": false | ||
| } | ||
| ], | ||
| ] | ||
| ``` | ||
| The issue is that `"modules": false` instructs Babel to _not_ transpile your ES6+ modules to a format like `CommonJS`, which typically allows Webpack to apply tree shaking to your code. | ||
| This module is provided as a part of Sitecore JavaScript Services. It contains a JavaScript implementation of the Sitecore pipeline pattern that is used to allow customizing the disconnected manifest. | ||
|
|
||
| Unfortunately, this doesn't play well with file-based pipelines when you use `babel-register` as a compiler for your pipeline processor files. `babel-register` transpiles your spec files on-the-fly and uses whatever Babel configuration it can find. Therefore, if you have a single `.babelrc` file or define your Babel config in `package.json`, then `babel-register` will use that config. And if that config uses `bable-preset-env` with `"modules": false`, then your spec files won't be transpiled. | ||
|
|
||
| The workaround at the moment, assuming you're using Webpack, is to move your Webpack-specific Babel config into your `babel-loader` options. Then use `.babelrc` (or equivalent) for other environments like unit testing and manifest generation. | ||
| Consult the [Sitecore JSS documentation](https://jss.sitecore.net) for further details. |