feat: Hidden 'dotfiles' within an extraResources folder aren't copied

Closes #733

Author: develar

docs/Options.md

@@ -184,6 +184,7 @@ macOS only.
 | Name | Description
 | --- | ---
 | **name** | <a name="Protocol-name"></a>The name. e.g. `IRC server URL`.
+| role | <a name="Protocol-role"></a>*macOS-only* The app’s role with respect to the type. The value can be `Editor`, `Viewer`, `Shell`, or `None`. Defaults to `Editor`.
 | **schemes** | <a name="Protocol-schemes"></a>The schemes. e.g. `["irc", "ircs"]`.
 
 <a name="MetadataDirectories"></a>
@@ -198,7 +199,14 @@ macOS only.
 
 # File Patterns
 
-[build.files](#BuildMetadata-files) defaults to `**/*` (i.e. [hidden files are ignored by default](https://www.npmjs.com/package/glob#dots)).
+[build.files](#BuildMetadata-files) defaults to:
+* `**/*`
+* `!**/node_modules/*/{README.md,README,readme.md,readme,test}`
+* `!**/node_modules/.bin`
+* `!**/*.{o,hprof,orig,pyc,pyo,rbc}`
+* `!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,__pycache__,thumbs.db}`
+
+[Hidden files are not ignored by default](https://www.npmjs.com/package/glob#dots), but as you see, all files that should be ignored, are ignored by default.
 
 Development dependencies are never copied in any case. You don't need to ignore it explicitly.
 

package.json

@@ -70,7 +70,7 @@
     "cli-cursor": "^1.0.2",
     "cuint": "^0.2.2",
     "debug": "^2.2.0",
-    "electron-download": "^2.1.2",
+    "electron-download": "2.1.2",
     "electron-osx-sign": "^0.4.0-beta4",
     "extract-zip": "^1.5.0",
     "fs-extra-p": "^1.1.8",
@@ -121,7 +121,7 @@
     "json8": "^0.9.2",
     "path-sort": "^0.1.0",
     "pre-git": "^3.10.0",
-    "ts-babel": "^1.0.6",
+    "ts-babel": "^1.0.7",
     "tslint": "^3.15.1",
     "typescript": "^2.0.2",
     "whitespace": "^2.1.0"

src/fileMatcher.ts

@@ -35,7 +35,8 @@ export class FileMatcher {
   }
 
   getParsedPatterns(fromDir?: string): Array<Minimatch> {
-    const minimatchOptions = {}
+    // https://github.com/electron-userland/electron-builder/issues/733
+    const minimatchOptions = {dot: true}
 
     const parsedPatterns: Array<Minimatch> = []
     const pathDifference = fromDir ? path.relative(fromDir, this.from) : null
@@ -67,7 +68,7 @@ export class FileMatcher {
     return pattern
       .replace(/\$\{arch}/g, this.options.arch)
       .replace(/\$\{os}/g, this.options.os)
-      .replace(/\$\{\/\*}/g, "{,/**/*,/**/.*}")
+      .replace(/\$\{\/\*}/g, "{,/**/*}")
   }
 }
 

src/platformPackager.ts

@@ -192,6 +192,9 @@ export abstract class PlatformPackager<DC extends PlatformSpecificBuildOptions>
         defaultMatcher.addPattern("**/*")
       }
       defaultMatcher.addPattern("!**/node_modules/*/{README.md,README,readme.md,readme,test}")
+      defaultMatcher.addPattern("!**/node_modules/.bin")
+      defaultMatcher.addPattern("!**/*.{o,hprof,orig,pyc,pyo,rbc}")
+      defaultMatcher.addPattern("!**/{.DS_Store,.git,.hg,.svn,CVS,RCS,SCCS,__pycache__,thumbs.db}")
 
       let rawFilter: any = null
       const deprecatedIgnore = (<any>this.devMetadata.build).ignore

test/src/globTest.ts

@@ -28,6 +28,30 @@ test.ifDevOrLinuxCi("ignore build resources", app({
   },
 }))
 
+test.ifDevOrLinuxCi("ignore known ignored files", app({
+  targets: Platform.LINUX.createTarget(DIR_TARGET),
+  devMetadata: {
+    build: {
+      asar: false
+    }
+  }
+}, {
+  projectDirCreated: projectDir => BluebirdPromise.all([
+    outputFile(path.join(projectDir, ".svn", "foo"), "data"),
+    outputFile(path.join(projectDir, ".git", "foo"), "data"),
+    outputFile(path.join(projectDir, "foo", "bar", "f.o"), "data"),
+    outputFile(path.join(projectDir, "node_modules", ".bin", "f.txt"), "data"),
+    outputFile(path.join(projectDir, "node_modules", ".bin2", "f.txt"), "data"),
+  ]),
+  packed: async context => {
+    await assertThat(path.join(context.getResources(Platform.LINUX), "app", ".svn")).doesNotExist()
+    await assertThat(path.join(context.getResources(Platform.LINUX), "app", ".git")).doesNotExist()
+    await assertThat(path.join(context.getResources(Platform.LINUX), "app", "foo", "bar", "f.o")).doesNotExist()
+    await assertThat(path.join(context.getResources(Platform.LINUX), "app", "node_modules", ".bin")).doesNotExist()
+    await assertThat(path.join(context.getResources(Platform.LINUX), "app", "node_modules", ".bin2")).isDirectory()
+  },
+}))
+
 test.ifDevOrLinuxCi("files", app({
   targets: Platform.LINUX.createTarget(DIR_TARGET),
   devMetadata: {
@@ -192,7 +216,6 @@ test("extraResources", async () => {
           }),
           outputFile(path.join(projectDir, "foo/nameWithoutDot"), "nameWithoutDot"),
           outputFile(path.join(projectDir, "bar/hello.txt"), "data"),
-          outputFile(path.join(projectDir, "foo", ".dot"), "data"),
           outputFile(path.join(projectDir, `bar/${process.arch}.txt`), "data"),
           outputFile(path.join(projectDir, `${osName}/${process.arch}.txt`), "data"),
           outputFile(path.join(projectDir, "platformSpecificR"), "platformSpecificR"),
@@ -212,7 +235,6 @@ test("extraResources", async () => {
         await assertThat(path.join(resourcesDir, osName, `${process.arch}.txt`)).isFile()
         await assertThat(path.join(resourcesDir, "platformSpecificR")).isFile()
         await assertThat(path.join(resourcesDir, "ignoreMe.txt")).doesNotExist()
-        await assertThat(path.join(resourcesDir, "foo", ".dot")).doesNotExist()
       },
       expectedContents: platform === Platform.WINDOWS ? pathSorter(expectedWinContents.concat(
         winDirPrefix + "bar/hello.txt",
@@ -262,7 +284,6 @@ test("extraResources - one-package", async () => {
           }),
           outputFile(path.join(projectDir, "foo/nameWithoutDot"), "nameWithoutDot"),
           outputFile(path.join(projectDir, "bar/hello.txt"), "data"),
-          outputFile(path.join(projectDir, "foo", ".dot"), "data"),
           outputFile(path.join(projectDir, `bar/${process.arch}.txt`), "data"),
           outputFile(path.join(projectDir, `${osName}/${process.arch}.txt`), "data"),
           outputFile(path.join(projectDir, "platformSpecificR"), "platformSpecificR"),
@@ -290,7 +311,6 @@ test("extraResources - one-package", async () => {
         await assertThat(path.join(resourcesDir, osName, `${process.arch}.txt`)).isFile()
         await assertThat(path.join(resourcesDir, "platformSpecificR")).isFile()
         await assertThat(path.join(resourcesDir, "ignoreMe.txt")).doesNotExist()
-        await assertThat(path.join(resourcesDir, "foo", ".dot")).doesNotExist()
       },
       expectedContents: platform === Platform.WINDOWS ? pathSorter(expectedWinContents.concat(
         winDirPrefix + "bar/hello.txt",