Merge pull request #78 from NaridaL/master

Changed `declare module "electron"` to export = Electron

Author: zeke

base/base_footer.ts

@@ -1,10 +1,9 @@
 declare module 'electron' {
-  const electron: Electron.AllElectron;
-  export = electron;
+  export = Electron;
 }
 
 interface NodeRequireFunction {
-  (moduleName: 'electron'): Electron.AllElectron;
+  (moduleName: 'electron'): typeof Electron;
 }
 
 interface File {

lib/master-interfaces.js

@@ -8,7 +8,8 @@ module.exports = (API, addToOutput) => {
   const CommonInterface = ['interface CommonInterface {']
   const MainInterface = ['interface MainInterface extends CommonInterface {']
   const RendererInterface = ['interface RendererInterface extends CommonInterface {']
-  const ElectronMainAndRendererInterface = ['interface AllElectron {']
+  const ElectronMainAndRendererInterface = ['interface AllElectron extends MainInterface, RendererInterface {}']
+  const constDeclarations = []
   const EMRI = {}
 
   const classify = (moduleName) => {
@@ -28,11 +29,20 @@ module.exports = (API, addToOutput) => {
     if (module.name === 'process') return
     let TargetInterface
     const isClass = module.type === 'Class' || API.some((tModule, tIndex) => index !== tIndex && tModule.name.toLowerCase() === module.name.toLowerCase())
-    const moduleString = `  ${classify(module.name)}: ${isClass ? 'typeof ' : ''}Electron.${_.upperFirst(module.name)}`
+    const moduleString = `  ${classify(module.name)}: ${isClass ? 'typeof ' : ''}${_.upperFirst(module.name)}`
     if (!module.process) {
       // We must be a structure or something
       return
     }
+    if (!isClass || module.name !== classify(module.name)) {
+      if (isClass) {
+        constDeclarations.push(
+          `type ${classify(module.name)} = ${_.upperFirst(module.name)};`,
+          `const ${classify(module.name)}: typeof ${_.upperFirst(module.name)};`)
+      } else {
+        constDeclarations.push(`const ${classify(module.name)}: ${_.upperFirst(module.name)};`)
+      }
+    }
     if (module.process.main && module.process.renderer) {
       TargetInterface = CommonInterface
     } else if (module.process.main) {
@@ -46,7 +56,6 @@ module.exports = (API, addToOutput) => {
     if (TargetInterface) {
       debug(classify(module.name).toLowerCase(), EMRI[classify(module.name).toLowerCase()])
       if (!EMRI[classify(module.name).toLowerCase()]) {
-        ElectronMainAndRendererInterface.push(moduleString)
         TargetInterface.push(moduleString)
       }
       EMRI[classify(module.name).toLowerCase()] = true
@@ -56,11 +65,11 @@ module.exports = (API, addToOutput) => {
   CommonInterface.push('}')
   MainInterface.push('}')
   RendererInterface.push('}')
-  ElectronMainAndRendererInterface.push('}')
 
   addToOutput([''])
   addToOutput(CommonInterface, ';')
   addToOutput(MainInterface, ';')
   addToOutput(RendererInterface, ';')
   addToOutput(ElectronMainAndRendererInterface, ';')
+  addToOutput(constDeclarations)
 }

test-smoke/electron/test/main.ts

@@ -23,6 +23,7 @@ import {
   session,
   systemPreferences,
   webContents,
+  Event,
 } from "electron";
 
 import * as path from "path";
@@ -33,6 +34,7 @@ import * as path from "path";
 // Keep a global reference of the window object, if you don't, the window will
 // be closed automatically when the javascript object is GCed.
 let mainWindow: Electron.BrowserWindow = null;
+const mainWindow2: BrowserWindow = null;
 
 // Quit when all windows are closed.
 app.on("window-all-closed", () => {
@@ -524,6 +526,11 @@ ipcMain.on("synchronous-message", (event: Electron.Event, arg: any) => {
   event.returnValue = "pong";
 });
 
+ipcMain.on("synchronous-message", (event: Event, arg: any) => {
+  console.log("event isn't namespaced and refers to the correct type.");
+  event.returnValue = "pong";
+});
+
 const winWindows = new BrowserWindow({
   width: 800,
   height: 600,

test/output_spec.js

@@ -8,13 +8,20 @@ const path = require('path')
 const OUTPUT_PATH = path.resolve(__dirname, '..', 'electron.d.ts')
 let output
 
+function getDefinitionsForInterface (interfaceName) {
+  const interface_ = output.match(interfaceName + '[^{]+{([\\s\\S]+?)}')
+  expect(interface_).to.be.an('array')
+  return interface_[1].split(';').map(l => l.trim())
+}
+
 describe('Definition File', function () {
   this.timeout(20000)
 
   before((done) => {
     spawn('node', ['cli.js', '-o=electron.d.ts'], {
       cwd: path.resolve(__dirname, '..')
     }).on('exit', () => done())
+    done()
   })
 
   it('should output a electron.d.ts file', () => {
@@ -23,18 +30,20 @@ describe('Definition File', function () {
   })
 
   it('should correctly output all exported Electron modules', () => {
-    const AllElectron = output.match(/AllElectron {([\s\S]+?)}/)
-    expect(AllElectron).to.be.an('array')
-    const AllElectronModules = AllElectron[1].split(';').map(l => l.trim())
+    const AllElectronModules = getDefinitionsForInterface('MainInterface').concat(
+      getDefinitionsForInterface('CommonInterface'),
+      getDefinitionsForInterface('RendererInterface')
+    )
     const knownElectronModules = ['clipboard', 'app', 'autoUpdater', 'dialog', 'ipcMain', 'Menu', 'MenuItem', 'webContents', 'BrowserWindow']
     knownElectronModules.forEach(knownModule => expect(AllElectronModules.some(tModule => tModule.indexOf(knownModule) === 0)).to.equal(true))
   })
 
   it('should not output classes that are not exported Electron modules', () => {
-    const AllElectron = output.match(/AllElectron {([\s\S]+?)}/)
-    expect(AllElectron).to.be.an('array')
-    const AllElectronModules = AllElectron[1].split(';').map(l => l.trim())
+    const AllElectronModules = getDefinitionsForInterface('MainInterface').concat(
+      getDefinitionsForInterface('CommonInterface'),
+      getDefinitionsForInterface('RendererInterface')
+    )
     const unKnownElectronModules = ['Clipboard', 'CrashReport', 'WebContents', 'menu', 'Session']
-    unKnownElectronModules.forEach(knownModule => expect(AllElectronModules.some(tModule => tModule.indexOf(knownModule) === 0)).to.equal(false))
+    unKnownElectronModules.forEach(knownModule => expect(AllElectronModules.some(tModule => tModule.indexOf(knownModule) === 0)).to.equal(false, knownModule))
   })
 })

tslint.json

@@ -13,6 +13,7 @@
     "no-namespace": false,
     "quotemark": false,
     "unified-signatures": false,
-    "variable-name": false
+    "variable-name": false,
+    "no-shadowed-variable": false
   }
 }