chore: disable Babel's ES modules' interop helper

By forcing to use the `import * as thing from 'thing'` syntax when importing CommonJS modules, Atom and VS Code can now provide type hints for imported modules, greatly improving developer experience.
strvcom · Dec 12, 2018 · e2d87b2 · e2d87b2
1 parent 7b27ac1
commit e2d87b2
Show file tree

Hide file tree

Showing 68 changed files with 103 additions and 98 deletions.
diff --git a/babel.config.js b/babel.config.js
@@ -8,6 +8,7 @@ module.exports = {
     '@babel/syntax-object-rest-spread',
     ['@babel/transform-modules-commonjs', {
       allowTopLevelThis: false,
+      noInterop: true,
     }],
     '@babel/proposal-class-properties',
     '@babel/proposal-function-bind',

diff --git a/packages/atlas/src/atlas.mjs b/packages/atlas/src/atlas.mjs
@@ -1,10 +1,10 @@
 // We use for-await pattern quite extensively here for legitimate purposes
 /* eslint-disable no-await-in-loop */
 
-import path from 'path'
-import Ajv from 'ajv'
-import ajvKeywords from 'ajv-keywords'
-import pino from 'pino'
+import * as path from 'path'
+import * as Ajv from 'ajv'
+import * as ajvKeywords from 'ajv-keywords'
+import * as pino from 'pino'
 import {
   defaultsDeep as defaults,
   isPlainObject,

diff --git a/packages/atlas/src/private/mklog.mjs b/packages/atlas/src/private/mklog.mjs
@@ -1,4 +1,4 @@
-import pino from 'pino'
+import * as pino from 'pino'
 
 /**
  * Create a new instance of logger (pino)

diff --git a/packages/atlas/test/democonfig/serialisers.mjs b/packages/atlas/test/democonfig/serialisers.mjs
@@ -1,4 +1,4 @@
-import pino from 'pino'
+import * as pino from 'pino'
 
 const stdSerializers = {
   err: pino.stdSerializers.err,

diff --git a/packages/atlas/test/init/init.test.mjs b/packages/atlas/test/init/init.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { FrameworkError } from '@atlas.js/errors'
 import { Atlas } from '../..'
 import * as testservices from './demoapp/services'

diff --git a/packages/aws/test/service/prepare.test.mjs b/packages/aws/test/service/prepare.test.mjs
@@ -1,4 +1,4 @@
-import awssdk from 'aws-sdk'
+import * as awssdk from 'aws-sdk'
 import { Service as AWS } from '../..'
 
 describe('AWS::prepare()', () => {

diff --git a/packages/braintree/src/index.mjs b/packages/braintree/src/index.mjs
@@ -1,4 +1,4 @@
-import Braintree from 'braintree'
+import * as Braintree from 'braintree'
 import Service from './service'
 
 export {

diff --git a/packages/braintree/src/service.mjs b/packages/braintree/src/service.mjs
@@ -1,4 +1,4 @@
-import braintree from 'braintree'
+import * as braintree from 'braintree'
 import Service from '@atlas.js/service'
 
 class Braintree extends Service {

diff --git a/packages/braintree/test/service/prepare.test.mjs b/packages/braintree/test/service/prepare.test.mjs
@@ -1,4 +1,4 @@
-import braintree from 'braintree'
+import * as braintree from 'braintree'
 import { Service as Braintree } from '../..'
 
 describe('Braintree::prepare()', () => {

diff --git a/packages/cli/src/bin/atlas.mjs b/packages/cli/src/bin/atlas.mjs
@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import 'source-map-support/register'
-import caporal from 'caporal'
+import * as caporal from 'caporal'
 import cli from '..'
 
 cli(caporal, process.argv)
diff --git a/packages/cli/src/command.mjs b/packages/cli/src/command.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 
 /**
  * The Command class represents a single CLI command

diff --git a/packages/cli/src/commands/exec.mjs b/packages/cli/src/commands/exec.mjs
@@ -1,4 +1,4 @@
-import os from 'os'
+import * as os from 'os'
 import Command from '../command'
 
 /**

diff --git a/packages/cli/src/commands/start.mjs b/packages/cli/src/commands/start.mjs
@@ -1,4 +1,4 @@
-import cluster from 'cluster'
+import * as cluster from 'cluster'
 import Command from '../command'
 
 class Start extends Command {

diff --git a/packages/cli/src/index.mjs b/packages/cli/src/index.mjs
@@ -1,19 +1,23 @@
-import fs from 'fs'
-import path from 'path'
-import pkg from '../package'
+import * as fs from 'fs'
+import * as path from 'path'
+import * as pkg from '../package'
 import commands from './commands'
 
 const help = fs.readFileSync(path.join(__dirname, 'more-info.txt'), 'utf8')
 
+/**
+ * @typedef  {import("caporal")} Caporal
+ */
+
 /**
  * The CLI entry point
  *
  * You should not call this function directly.
  *
  * @private
- * @param     {Object}    caporal     The caporal module
+ * @param     {Caporal}   caporal     The caporal module
  * @param     {Array}     argv        CLI arguments
- * @return    {caporal~Program}
+ * @return    {void}
  */
 export default function cli(caporal, argv) {
   caporal.version(pkg.version)

diff --git a/packages/cli/test/cli.test.mjs b/packages/cli/test/cli.test.mjs
@@ -1,4 +1,4 @@
-import caporal from 'caporal'
+import * as caporal from 'caporal'
 import commands from '../src/commands'
 import cli from '..'
 

diff --git a/packages/cli/test/command/command.test.mjs b/packages/cli/test/command/command.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import Command from '../../src/command'
 
 describe('CLI: Command', () => {

diff --git a/packages/cli/test/commands/start.test.mjs b/packages/cli/test/commands/start.test.mjs
@@ -1,4 +1,4 @@
-import cluster from 'cluster'
+import * as cluster from 'cluster'
 import Start from '../../src/commands/start'
 
 describe('CLI: start', () => {

diff --git a/packages/firebase/src/index.mjs b/packages/firebase/src/index.mjs
@@ -1,4 +1,4 @@
-import firebase from 'firebase-admin'
+import * as firebase from 'firebase-admin'
 import Service from './service'
 
 export {

diff --git a/packages/firebase/test/service/prepare.test.mjs b/packages/firebase/test/service/prepare.test.mjs
@@ -1,5 +1,5 @@
-import path from 'path'
-import Admin from 'firebase-admin'
+import * as path from 'path'
+import * as Admin from 'firebase-admin'
 import { Service as Firebase } from '../..'
 
 describe('Firebase::prepare()', () => {

diff --git a/packages/firebase/test/service/stop.test.mjs b/packages/firebase/test/service/stop.test.mjs
@@ -1,4 +1,4 @@
-import Admin from 'firebase-admin'
+import * as Admin from 'firebase-admin'
 import { Service as Firebase } from '../..'
 
 let service

diff --git a/packages/generator/generators/app/index.mjs b/packages/generator/generators/app/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 const generators = {
   npm: require.resolve('generator-npm-init'),

diff --git a/packages/generator/generators/boilerplate/index.mjs b/packages/generator/generators/boilerplate/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 const files = [
   ['env', '.env'],

diff --git a/packages/generator/generators/editorconfig/index.mjs b/packages/generator/generators/editorconfig/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 class EditorConfig extends Generator {
   constructor(...args) {

diff --git a/packages/generator/generators/eslint/index.mjs b/packages/generator/generators/eslint/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 const files = [
   ['eslintrc.js', '.eslintrc.js'],

diff --git a/packages/generator/generators/gitignore/index.mjs b/packages/generator/generators/gitignore/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 class Gitignore extends Generator {
   writing() {

diff --git a/packages/generator/generators/testsuite/index.mjs b/packages/generator/generators/testsuite/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 const files = [
   'test/mocha.opts',

diff --git a/packages/generator/generators/testsuite/templates/test/bootstrap.mjs b/packages/generator/generators/testsuite/templates/test/bootstrap.mjs
@@ -1,9 +1,9 @@
 import 'source-map-support/register'
-import sinon from 'sinon'
-import chai from 'chai'
-import chaiAsPromised from 'chai-as-promised'
-import sinonChai from 'sinon-chai'
-import dirtyChai from 'dirty-chai'
+import * as sinon from 'sinon'
+import * as chai from 'chai'
+import * as chaiAsPromised from 'chai-as-promised'
+import * as sinonChai from 'sinon-chai'
+import * as dirtyChai from 'dirty-chai'
 
 // Make sure our tests always run in the 'test' environment
 // eslint-disable-next-line no-process-env

diff --git a/packages/generator/generators/vscode/index.mjs b/packages/generator/generators/vscode/index.mjs
@@ -1,4 +1,4 @@
-import Generator from 'yeoman-generator'
+import * as Generator from 'yeoman-generator'
 
 const files = [
   '.vscode/launch.json',

diff --git a/packages/koa/src/server.mjs b/packages/koa/src/server.mjs
@@ -1,7 +1,7 @@
-import http from 'http'
+import * as http from 'http'
 import Service from '@atlas.js/service'
 import { FrameworkError } from '@atlas.js/errors'
-import Koa from 'koa'
+import * as Koa from 'koa'
 import middleware from './middleware'
 
 class KoaService extends Service {

diff --git a/packages/koa/src/websocket.mjs b/packages/koa/src/websocket.mjs
@@ -1,5 +1,5 @@
 import Hook from '@atlas.js/hook'
-import websocket from 'koa-websocket'
+import * as websocket from 'koa-websocket'
 import middleware from './middleware'
 
 class WebsocketHook extends Hook {

diff --git a/packages/koa/test/server/prepare.test.mjs b/packages/koa/test/server/prepare.test.mjs
@@ -1,5 +1,5 @@
-import path from 'path'
-import Koa from 'koa'
+import * as path from 'path'
+import * as Koa from 'koa'
 import { Server as Service } from '../..'
 import * as testmiddleware from './testmiddleware'
 

diff --git a/packages/koa/test/server/start.test.mjs b/packages/koa/test/server/start.test.mjs
@@ -1,4 +1,4 @@
-import http from 'http'
+import * as http from 'http'
 import { Server as Koa } from '../..'
 
 describe('Koa::start(instance)', () => {

diff --git a/packages/koa/test/server/stop.test.mjs b/packages/koa/test/server/stop.test.mjs
@@ -1,4 +1,4 @@
-import http from 'http'
+import * as http from 'http'
 import { FrameworkError } from '@atlas.js/errors'
 import { Server as Koa } from '../..'
 

diff --git a/packages/koa/test/websocket/api.test.mjs b/packages/koa/test/websocket/api.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { Atlas } from '@atlas.js/atlas'
 import Hook from '@atlas.js/hook'
 import { WebsocketHook } from '../..'

diff --git a/packages/mongoose/src/index.mjs b/packages/mongoose/src/index.mjs
@@ -1,4 +1,4 @@
-import mongoose from 'mongoose'
+import * as mongoose from 'mongoose'
 import Service from './service'
 import ModelsHook from './models'
 

diff --git a/packages/mongoose/src/service.mjs b/packages/mongoose/src/service.mjs
@@ -1,5 +1,5 @@
 import Service from '@atlas.js/service'
-import mongoose from 'mongoose'
+import * as mongoose from 'mongoose'
 
 class Mongoose extends Service {
   static config = {

diff --git a/packages/mongoose/test/model/api.test.mjs b/packages/mongoose/test/model/api.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { Atlas } from '@atlas.js/atlas'
 import { ModelsHook } from '../..'
 import * as testmodels from './testmodels'

diff --git a/packages/mongoose/test/service/prepare.test.mjs b/packages/mongoose/test/service/prepare.test.mjs
@@ -1,4 +1,4 @@
-import mongoose from 'mongoose'
+import * as mongoose from 'mongoose'
 import { Service as Mongoose } from '../..'
 
 describe('Mongoose::prepare()', () => {

diff --git a/packages/mongoose/test/service/start.test.mjs b/packages/mongoose/test/service/start.test.mjs
@@ -1,4 +1,4 @@
-import mongoose from 'mongoose'
+import * as mongoose from 'mongoose'
 import { Service as Mongoose } from '../..'
 
 describe('Mongoose::start()', () => {

diff --git a/packages/nodemailer/src/index.mjs b/packages/nodemailer/src/index.mjs
@@ -1,4 +1,4 @@
-import nodemailer from 'nodemailer'
+import * as nodemailer from 'nodemailer'
 import Service from './service'
 
 export {

diff --git a/packages/nodemailer/src/service.mjs b/packages/nodemailer/src/service.mjs
@@ -1,4 +1,4 @@
-import nodemailer from 'nodemailer'
+import * as nodemailer from 'nodemailer'
 import Service from '@atlas.js/service'
 
 class Nodemailer extends Service {

diff --git a/packages/nodemailer/test/service/prepare.test.mjs b/packages/nodemailer/test/service/prepare.test.mjs
@@ -1,7 +1,7 @@
-import path from 'path'
-import nodemailer from 'nodemailer'
+import * as path from 'path'
+import * as nodemailer from 'nodemailer'
 import { Service as Nodemailer } from '../..'
-import dummytransport from './dummytransport'
+import * as dummytransport from './dummytransport'
 
 describe('Nodemailer::prepare()', () => {
   let service

diff --git a/packages/nodemailer/test/service/send.test.mjs b/packages/nodemailer/test/service/send.test.mjs
@@ -1,4 +1,4 @@
-import nodemailer from 'nodemailer'
+import * as nodemailer from 'nodemailer'
 import { Service as Nodemailer } from '../..'
 
 describe('Nodemailer - instance::send()', () => {

diff --git a/packages/nodemailer/test/service/stop.test.mjs b/packages/nodemailer/test/service/stop.test.mjs
@@ -1,4 +1,4 @@
-import nodemailer from 'nodemailer'
+import * as nodemailer from 'nodemailer'
 import { Service as Nodemailer } from '../..'
 
 describe('Nodemailer::stop()', () => {

diff --git a/packages/objection/src/index.mjs b/packages/objection/src/index.mjs
@@ -1,4 +1,4 @@
-import objection from 'objection'
+import * as objection from 'objection'
 import Service from './service'
 import MigrationAction from './migration'
 

diff --git a/packages/objection/src/migration.mjs b/packages/objection/src/migration.mjs
@@ -1,5 +1,5 @@
-import path from 'path'
-import Umzug from 'umzug'
+import * as path from 'path'
+import * as Umzug from 'umzug'
 import Action from '@atlas.js/action'
 
 class Migration extends Action {

diff --git a/packages/objection/src/service.mjs b/packages/objection/src/service.mjs
@@ -1,4 +1,4 @@
-import knex from 'knex'
+import * as knex from 'knex'
 import Service from '@atlas.js/service'
 import { FrameworkError } from '@atlas.js/errors'
 

diff --git a/packages/objection/test/migration/down.test.mjs b/packages/objection/test/migration/down.test.mjs
@@ -1,4 +1,4 @@
-import Umzug from 'umzug'
+import * as Umzug from 'umzug'
 import { MigrationAction as Migration } from '../..'
 
 describe('Migration::down()', () => {

diff --git a/packages/objection/test/migration/pending.test.mjs b/packages/objection/test/migration/pending.test.mjs
@@ -1,4 +1,4 @@
-import Umzug from 'umzug'
+import * as Umzug from 'umzug'
 import { MigrationAction as Migration } from '../..'
 
 describe('Migration::pending()', () => {

diff --git a/packages/objection/test/migration/up.test.mjs b/packages/objection/test/migration/up.test.mjs
@@ -1,4 +1,4 @@
-import Umzug from 'umzug'
+import * as Umzug from 'umzug'
 import { MigrationAction as Migration } from '../..'
 
 describe('Migration::up()', () => {

diff --git a/packages/objection/test/service/prepare.test.mjs b/packages/objection/test/service/prepare.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { errors } from '@atlas.js/atlas'
 import { Service as Objection } from '../..'
 import * as models from './models'

diff --git a/packages/objection/test/service/start.test.mjs b/packages/objection/test/service/start.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { Service as Objection } from '../..'
 import * as models from './models'
 

diff --git a/packages/objection/test/service/stop.test.mjs b/packages/objection/test/service/stop.test.mjs
@@ -1,4 +1,4 @@
-import path from 'path'
+import * as path from 'path'
 import { Service as Objection } from '../..'
 
 describe('Objection::stop()', () => {

diff --git a/packages/repl/src/action.mjs b/packages/repl/src/action.mjs
@@ -1,8 +1,8 @@
-import os from 'os'
-import fs from 'fs'
-import path from 'path'
-import repl from 'repl'
-import fsp from 'promisified-core/fs'
+import * as os from 'os'
+import * as fs from 'fs'
+import * as path from 'path'
+import * as repl from 'repl'
+import * as fsp from 'promisified-core/fs'
 import Action from '@atlas.js/action'
 
 class Repl extends Action {