-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
hurray! more docs on Files config and FileSets
- Loading branch information
Showing
14 changed files
with
117 additions
and
97 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
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
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
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
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
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
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,9 +1,9 @@ | ||
| # electron-forge-maker-nsis-web | ||
|
|
||
| [electron-builder](https://github.com/electron-userland/electron-builder) [nsis-web](https://electron.build/configuration/nsis) target for electron-forge. | ||
| [electron-builder](https://github.com/electron-userland/electron-builder) [nsis-web](https://electron.build/nsis) target for electron-forge. | ||
|
|
||
| Recommended to build electron-forge project using electron-builder directly. | ||
| [Publishing](https://www.electron.build/configuration/publish), | ||
| [Publishing](https://www.electron.build/publish), | ||
| [Auto Update](https://electron.build/auto-update) | ||
| and [Code Signing](https://electron.build/code-signing) supported only in this case | ||
| (including all other useful [packaging options](https://electron.build/configuration/configuration) like [files](https://electron.build./configuration.md#Config-files)). | ||
| (including all other useful [packaging options](https://electron.build/configuration) like [files](https://electron.build./configuration.md#Config-files)). |
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,9 +1,9 @@ | ||
| # electron-forge-maker-nsis | ||
|
|
||
| [electron-builder](https://github.com/electron-userland/electron-builder) [nsis](https://electron.build/configuration/nsis) target for electron-forge. | ||
| [electron-builder](https://github.com/electron-userland/electron-builder) [nsis](https://electron.build/nsis) target for electron-forge. | ||
|
|
||
| Recommended to build electron-forge project using electron-builder directly. | ||
| [Publishing](https://www.electron.build/configuration/publish), | ||
| [Publishing](https://www.electron.build/publish), | ||
| [Auto Update](https://electron.build/auto-update) | ||
| and [Code Signing](https://electron.build/code-signing) supported only in this case | ||
| (including all other useful [packaging options](https://electron.build/configuration/configuration) like [files](https://electron.build./configuration.md#Config-files)). | ||
| (including all other useful [packaging options](https://electron.build/configuration) like [files](https://electron.build./configuration.md#Config-files)). |
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
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,7 +1,7 @@ | ||
| # electron-publish | ||
|
|
||
| Part of [electron-builder](https://github.com/electron-userland/electron-builder). | ||
| Part of [electron-builder](https://github.com/electron-userland/electron-builder). | ||
|
|
||
| See the [Publishing Artifacts](https://www.electron.build/configuration/publish) for more information. | ||
| See the [Publishing Artifacts](https://www.electron.build/publish) for more information. | ||
|
|
||
| Can be used standalone. |
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
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,61 +1,7 @@ | ||
| ## files | ||
| # File Contents | ||
|
|
||
| `Array<String | FileSet> | String | FileSet` | ||
|
|
||
| A [glob patterns](./file-patterns.md) relative to the [app directory](configuration.md#MetadataDirectories-app), which specifies which files to include when copying files to create the package. | ||
|
|
||
| Defaults to: | ||
| ```json | ||
| [ | ||
| "**/*", | ||
| "!**/node_modules/*/{CHANGELOG.md,README.md,README,readme.md,readme}", | ||
| "!**/node_modules/*/{test,__tests__,tests,powered-test,example,examples}", | ||
| "!**/node_modules/*.d.ts", | ||
| "!**/node_modules/.bin", | ||
| "!**/*.{iml,o,hprof,orig,pyc,pyo,rbc,swp,csproj,sln,xproj}", | ||
| "!.editorconfig", | ||
| "!**/._*", | ||
| "!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,.gitignore,.gitattributes}", | ||
| "!**/{__pycache__,thumbs.db,.flowconfig,.idea,.vs,.nyc_output}", | ||
| "!**/{appveyor.yml,.travis.yml,circle.yml}", | ||
| "!**/{npm-debug.log,yarn.lock,.yarn-integrity,.yarn-metadata.json}" | ||
| ] | ||
| ``` | ||
|
|
||
| Development dependencies are never copied in any case. You don't need to ignore it explicitly. Hidden files are not ignored by default, but all files that should be ignored, are ignored by default. | ||
|
|
||
| Default pattern `**/*` **is not added to your custom** if some of your patterns is not ignore (i.e. not starts with `!`). `package.json` and `**/node_modules/**/*` (only production dependencies will be copied) is added to your custom in any case. All default ignores are added in any case — you don't need to repeat it if you configure own patterns. | ||
|
|
||
| May be specified in the platform options (e.g. in the [mac](mac.md)). | ||
|
|
||
| You may also specify custom source and destination directories by using `FileSet` objects instead of simple glob patterns. | ||
|
|
||
| ```json | ||
| [ | ||
| { | ||
| "from": "path/to/source", | ||
| "to": "path/to/destination", | ||
| "filter": ["**/*", "!foo/*.js"] | ||
| } | ||
| ] | ||
| ``` | ||
|
|
||
| You can use [file macros](../file-patterns.md#file-macros) in the `from` and `to` fields as well. `from` and `to` can be files and you can use this to [rename](https://github.com/electron-userland/electron-builder/issues/1119) a file while packaging. | ||
|
|
||
| ## extraResources | ||
|
|
||
| `Array<String | FileSet> | String | FileSet` | ||
|
|
||
| A [glob patterns](../file-patterns.md) relative to the project directory, when specified, copy the file or directory with matching names directly into the app's resources directory (`Contents/Resources` for MacOS, `resources` for Linux and Windows). | ||
|
|
||
| File patterns (and support for `from` and `to` fields) the same as for [files](#files). | ||
|
|
||
| ## extraFiles | ||
|
|
||
| `Array<String | FileSet> | String | FileSet` | ||
|
|
||
| The same as [extraResources](#extraresources) but copy into the app's content directory (`Contents` for MacOS, root directory for Linux and Windows). | ||
| {% include-markdown "./app-builder-lib.Interface.FilesBuildOptions.md" heading-offset=1 %} | ||
|
|
||
| # FileSet Configuration | ||
|
|
||
| {% include "./app-builder-lib.Interface.FileSet.md" %} | ||
| {% include-markdown "./app-builder-lib.Interface.FileSet.md" heading-offset=2 %} |
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,12 @@ | ||
| {% include "./app-builder-lib/globals.md" %} | ||
| {% include "./builder-util-runtime/globals.md" %} | ||
| {% include "./builder-util/globals.md" %} | ||
| {% include "./dmg-builder/globals.md" %} | ||
| {% include "./electron-builder-squirrel-windows/globals.md" %} | ||
| {% include "./electron-builder/globals.md" %} | ||
| {% include "./electron-forge-maker-appimage/globals.md" %} | ||
| {% include "./electron-forge-maker-nsis-web/globals.md" %} | ||
| {% include "./electron-forge-maker-nsis/globals.md" %} | ||
| {% include "./electron-forge-maker-snap/globals.md" %} | ||
| {% include "./electron-publish/globals.md" %} | ||
| {% include "./electron-updater/globals.md" %} |
Oops, something went wrong.