feat: omitIndex option

closes #16

Author: jackmellis

README.md

@@ -80,3 +80,23 @@ import { MyService } from "/src/services";
 ```
 
 This is only in terms of resolving a dependency's name, it doesn't actually update the import path.
+
+### omitIndex
+
+```ts
+boolean;
+```
+
+When registering a dependency in an index file, the index will be omitted.
+
+For example:
+
+```ts
+// /src/services/index.ts
+
+type MyService = any;
+
+jpex.service<MyService>(myService);
+```
+
+This would normally produce a type name of `type:/src/services/index/MyService`. With omitIndex it will create `type:/src/services/MyService`.

src/index.ts

@@ -20,6 +20,7 @@ const mainVisitor: Visitor<{
   opts: {
     identifier: string[],
     publicPath: string | boolean,
+    omitIndex: boolean,
     pathAlias: {
       [key: string]: string,
     },
@@ -31,22 +32,25 @@ const mainVisitor: Visitor<{
       opts: {
         identifier = 'jpex',
         publicPath,
-        pathAlias,
+        // eslint-disable-next-line prefer-const
+        pathAlias = {},
+        // eslint-disable-next-line prefer-const
+        omitIndex,
       } = {},
     } = state;
-    const filename = this
+    let filename = this
       .filename
       .split('.')
       .slice(0, -1)
       .join('.')
       .replace(process.cwd(), '');
+    if (omitIndex && filename.endsWith('/index')) {
+      filename = filename.replace('/index', '');
+    }
     identifier = [].concat(identifier);
     if (publicPath === true) {
       publicPath = require(resolve('./package.json')).name;
     }
-    if (pathAlias == null) {
-      pathAlias = {};
-    }
     const opts = {
       identifier,
       filename,

tests/index.ts

@@ -0,0 +1,37 @@
+import test from 'ava';
+import { transformAsync } from '@babel/core';
+
+test('index', async(t) => {
+  const code = `
+    // transforms code
+    import jpex from 'jpex';
+    
+    type Foo = string;
+    type Baz = () => string;
+    type Bar = number;
+    
+    jpex.factory<Foo>(() => 'foo');
+    jpex.constant<Bar>(44);
+    jpex.factory<Baz>((foo: Foo, bar: Bar) => () => \`\${foo}\${bar}\`);
+    
+    const result = jpex.resolve<Baz>();    
+  `;
+  const { code: actual } = await transformAsync(code, {
+    filename: './code/index.ts',
+    babelrc: false,
+    configFile: false,
+    presets: [
+      '@babel/preset-typescript',
+    ],
+    plugins: [
+      [
+        './dist',
+        {
+          omitIndex: true,
+        },
+      ],
+    ],
+  });
+
+  t.snapshot(actual);
+});

tests/snapshots/index.ts.md

@@ -0,0 +1,16 @@
+# Snapshot report for `tests/index.ts`
+
+The actual snapshot is saved in `index.ts.snap`.
+
+Generated by [AVA](https://avajs.dev).
+
+## index
+
+> Snapshot 1
+
+    `// transforms code␊
+    import jpex from 'jpex';␊
+    jpex.factory("type:/code/Foo", [], () => 'foo');␊
+    jpex.constant("type:/code/Bar", 44);␊
+    jpex.factory("type:/code/Baz", ["type:/code/Foo", "type:/code/Bar"], (foo, bar) => () => `${foo}${bar}`);␊
+    const result = jpex.resolve("type:/code/Baz");`